KisBookmarkedConfigurationsModel Class Reference

#include <kis_bookmarked_configurations_model.h>

Inheritance diagram for KisBookmarkedConfigurationsModel:

Classes
struct	Private

Public Member Functions
KisBookmarkedConfigurationManager *	bookmarkedConfigurationManager ()
KisSerializableConfigurationSP	configuration (const QModelIndex &index) const
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
virtual void	deleteIndex (const QModelIndex &index)
Qt::ItemFlags	flags (const QModelIndex &index) const override
QModelIndex	indexFor (const QString &name) const
virtual bool	isIndexDeletable (const QModelIndex &index) const
	KisBookmarkedConfigurationsModel (KisBookmarkedConfigurationManager *)
virtual void	newConfiguration (KLocalizedString baseName, const KisSerializableConfigurationSP config)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
virtual void	saveConfiguration (const QString &name, const KisSerializableConfigurationSP config)
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
	~KisBookmarkedConfigurationsModel () override

Private Attributes
Private *const	d

Detailed Description

This class provides the basic functionality for a model of a bookmark of configurations.

Definition at line 23 of file kis_bookmarked_configurations_model.h.

Constructor & Destructor Documentation

KisBookmarkedConfigurationsModel()

KisBookmarkedConfigurationsModel::KisBookmarkedConfigurationsModel

(

KisBookmarkedConfigurationManager *

bm

)

Initialized thee model with the bookmarks manager

Definition at line 23 of file kis_bookmarked_configurations_model.cc.

                                                                                                        : d(new Private)
{
    d->bookmarkManager = bm;
    d->configsKey = d->bookmarkManager->configurations();
    std::sort(d->configsKey.begin(), d->configsKey.end());
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationsModel::Private::configsKey, KisBookmarkedConfigurationManager::configurations(), and d.

~KisBookmarkedConfigurationsModel()

KisBookmarkedConfigurationsModel::~KisBookmarkedConfigurationsModel ( )

override

Definition at line 30 of file kis_bookmarked_configurations_model.cc.

{
    delete d;
}

References d.

Member Function Documentation

bookmarkedConfigurationManager()

KisBookmarkedConfigurationManager * KisBookmarkedConfigurationsModel::bookmarkedConfigurationManager

(

)

Returns

the bookmarked configuration manager associated with this model.

Definition at line 35 of file kis_bookmarked_configurations_model.cc.

{
    return d->bookmarkManager;
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, and d.

configuration()

KisSerializableConfigurationSP KisBookmarkedConfigurationsModel::configuration

(

const QModelIndex &

index

)

const

Returns

the configuration at the given index

Definition at line 80 of file kis_bookmarked_configurations_model.cc.

{
    if (!index.isValid()) return 0;
    switch (index.row()) {
    case 0:
        dbgKrita << "loading default" << Qt::endl;
        return d->bookmarkManager->load(KisBookmarkedConfigurationManager::ConfigDefault);
        break;
    case 1:
        return d->bookmarkManager->load(KisBookmarkedConfigurationManager::ConfigLastUsed);
        break;
    default:
        return d->bookmarkManager->load(d->configsKey[ index.row() - 2 ]);
    }
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationManager::ConfigDefault, KisBookmarkedConfigurationManager::ConfigLastUsed, KisBookmarkedConfigurationsModel::Private::configsKey, d, dbgKrita, and KisBookmarkedConfigurationManager::load().

data()

QVariant KisBookmarkedConfigurationsModel::data ( const QModelIndex & index, int role = Qt::DisplayRole ) const

override

When role == Qt::DisplayRole, this function will return the name of the configuration.

Definition at line 46 of file kis_bookmarked_configurations_model.cc.

{
    if (!index.isValid()) {
        return QVariant();
    }
    if (role == Qt::DisplayRole || role == Qt::EditRole) {
        switch (index.row()) {
        case 0:
            return i18n("Default");
        case 1:
            return i18n("Last Used");
        default:
            return d->configsKey[ index.row() - 2 ];
        }
    }
    return QVariant();
}

References KisBookmarkedConfigurationsModel::Private::configsKey, and d.

deleteIndex()

void KisBookmarkedConfigurationsModel::deleteIndex ( const QModelIndex & index )

virtual

Delete the configuration at the given index. (if possible)

Definition at line 124 of file kis_bookmarked_configurations_model.cc.

{
    if (!index.isValid() || index.row() < 2) return ;
    int idx = index.row() - 2;
    d->bookmarkManager->remove(d->configsKey[idx]);
    beginRemoveRows(QModelIndex(), idx + 2, idx + 2);
    d->configsKey.removeAt(idx);
    endRemoveRows();
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationsModel::Private::configsKey, d, and KisBookmarkedConfigurationManager::remove().

flags()

Qt::ItemFlags KisBookmarkedConfigurationsModel::flags ( const QModelIndex & index ) const

override

Returns

the flags associated to the index

Definition at line 134 of file kis_bookmarked_configurations_model.cc.

{
    if (!index.isValid()) return QFlags<Qt::ItemFlag>();
 
    switch (index.row()) {
    case 0:
        return Qt::ItemIsSelectable | Qt::ItemIsEnabled;
    case 1:
        if (d->bookmarkManager->exists(KisBookmarkedConfigurationManager::ConfigLastUsed)) {
            return Qt::ItemIsSelectable | Qt::ItemIsEnabled;
        } else {
            return QFlags<Qt::ItemFlag>();
        }
    default:
        return Qt::ItemIsSelectable | Qt::ItemIsEditable | Qt::ItemIsEnabled;
    }
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationManager::ConfigLastUsed, d, and KisBookmarkedConfigurationManager::exists().

indexFor()

QModelIndex KisBookmarkedConfigurationsModel::indexFor

(

const QString &

name

)

const

Returns

the index corresponding to the name .

Definition at line 96 of file kis_bookmarked_configurations_model.cc.

{
    int idx = d->configsKey.indexOf(name);
    if (idx == -1) return QModelIndex();
    return createIndex(idx + 2, 0);
}

References KisBookmarkedConfigurationsModel::Private::configsKey, and d.

isIndexDeletable()

bool KisBookmarkedConfigurationsModel::isIndexDeletable ( const QModelIndex & index ) const

virtual

Returns

true if the configuration at the given index can be removed

Definition at line 103 of file kis_bookmarked_configurations_model.cc.

{
    if (!index.isValid() || index.row() < 2) return false;
    return true;
}

newConfiguration()

void KisBookmarkedConfigurationsModel::newConfiguration ( KLocalizedString baseName, const KisSerializableConfigurationSP config )

virtual

Insert a new configuration.

Definition at line 109 of file kis_bookmarked_configurations_model.cc.

{
    saveConfiguration(d->bookmarkManager->uniqueName(baseName), config);
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, d, saveConfiguration(), and KisBookmarkedConfigurationManager::uniqueName().

rowCount()

int KisBookmarkedConfigurationsModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

Returns

the number of configurations (the minimum is always 2, the default configuration and the last used configuration are always present)

Definition at line 40 of file kis_bookmarked_configurations_model.cc.

{
    Q_UNUSED(parent);
    return 2 + d->configsKey.size();
}

References KisBookmarkedConfigurationsModel::Private::configsKey, and d.

saveConfiguration()

void KisBookmarkedConfigurationsModel::saveConfiguration ( const QString & name, const KisSerializableConfigurationSP config )

virtual

Save a configuration to the bookmark manager.

Definition at line 114 of file kis_bookmarked_configurations_model.cc.

{
    d->bookmarkManager->save(name, config);
    if (!d->configsKey.contains(name)) {
        beginInsertRows(QModelIndex(), d->configsKey.count() + 2, d->configsKey.count() + 2);
        d->configsKey << name;
        endInsertRows();
    }
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationsModel::Private::configsKey, d, and KisBookmarkedConfigurationManager::save().

setData()

bool KisBookmarkedConfigurationsModel::setData ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole )

override

Definition at line 64 of file kis_bookmarked_configurations_model.cc.

{
    if (role == Qt::EditRole && index.row() >= 2) {
        QString name = value.toString();
        int idx = index.row() - 2;
        KisSerializableConfigurationSP config = d->bookmarkManager->load(d->configsKey[idx]);
        d->bookmarkManager->remove(d->configsKey[idx]);
        d->bookmarkManager->save(name, config);
        d->configsKey[idx] = name;
 
        emit(dataChanged(index, index));
        return true;
    }
    return false;
}

References KisBookmarkedConfigurationsModel::Private::bookmarkManager, KisBookmarkedConfigurationsModel::Private::configsKey, d, KisBookmarkedConfigurationManager::load(), KisBookmarkedConfigurationManager::remove(), KisBookmarkedConfigurationManager::save(), and value().

Member Data Documentation

d

Private* const KisBookmarkedConfigurationsModel::d

private

Definition at line 76 of file kis_bookmarked_configurations_model.h.

---

The documentation for this class was generated from the following files:

• libs/ui/kis_bookmarked_configurations_model.h
• libs/ui/kis_bookmarked_configurations_model.cc