KisCompositeOpListModel Class Reference

#include <kis_composite_ops_model.h>

Inheritance diagram for KisCompositeOpListModel:

Public Member Functions
virtual QString	categoryToString (const KoID &val) const
QVariant	data (const QModelIndex &idx, int role=Qt::DisplayRole) const override
virtual QString	entryToString (const KoID &val) const
void	initialize ()
void	initializeForLayerStyles ()
void	readFavoriteCompositeOpsFromConfig ()
bool	setData (const QModelIndex &idx, const QVariant &value, int role=Qt::EditRole) override
void	validate (const KoColorSpace *cs)
void	writeFavoriteCompositeOpsToConfig () const
Public Member Functions inherited from KisCategorizedListModel< TEntry, TEntryToQStringConverter >
SpecificCategoriesMapper *	categoriesMapper ()
const SpecificCategoriesMapper *	categoriesMapper () const
QVariant	data (const QModelIndex &idx, int role=Qt::DisplayRole) const override
bool	entryAt (TEntry &entry, QModelIndex index) const
Qt::ItemFlags	flags (const QModelIndex &idx) const override
QModelIndex	indexOf (const TEntry &entry) const
	KisCategorizedListModel (QObject *parent=0)
int	rowCount (const QModelIndex &parent) const override
bool	setData (const QModelIndex &idx, const QVariant &value, int role=Qt::EditRole) override
Public Member Functions inherited from __CategorizedListModelBase
	__CategorizedListModelBase (QObject *parent)
	~__CategorizedListModelBase () override

Static Public Member Functions
static KoID	favoriteCategory ()
static KisCompositeOpListModel *	sharedInstance ()

Private Member Functions
void	addFavoriteEntry (const KoID &entry)
void	removeFavoriteEntry (const KoID &entry)

Additional Inherited Members
Public Types inherited from KisCategorizedListModel< TEntry, TEntryToQStringConverter >
typedef SpecificCategoriesMapper::DataItem	DataItem
typedef TEntry	Entry_Type
typedef KisCategoriesMapper< TEntry, TEntryToQStringConverter >	SpecificCategoriesMapper
Public Types inherited from __CategorizedListModelBase
enum	AdditionalRoles {   IsHeaderRole = Qt::UserRole + 1 , ExpandCategoryRole = Qt::UserRole + 2 , SortRole = Qt::UserRole + 3 , isLockedRole = Qt::UserRole + 4 ,   isLockableRole = Qt::UserRole + 5 , isToggledRole = Qt::UserRole + 6 }

Detailed Description

Definition at line 24 of file kis_composite_ops_model.h.

Member Function Documentation

addFavoriteEntry()

void KisCompositeOpListModel::addFavoriteEntry ( const KoID & entry )

private

Definition at line 136 of file kis_composite_ops_model.cc.

{
    DataItem *item = categoriesMapper()->addEntry(favoriteCategory().name(), entry);
    item->setCheckable(false);
}

References KisCategoriesMapper< TEntry, TEntryToQStringConverter >::addEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), favoriteCategory(), and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setCheckable().

categoryToString()

virtual QString KisCompositeOpListModel::categoryToString ( const KoID & val ) const

inlinevirtual

Definition at line 29 of file kis_composite_ops_model.h.

{ return val.name(); }

References KoID::name().

data()

QVariant KisCompositeOpListModel::data ( const QModelIndex & idx, int role = Qt::DisplayRole ) const

override

Definition at line 116 of file kis_composite_ops_model.cc.

{
    if (!idx.isValid()) return QVariant();
 
    if(role == Qt::DecorationRole) {
        DataItem *item = categoriesMapper()->itemFromRow(idx.row());
        Q_ASSERT(item);
 
        if (!item->isCategory() && !item->isEnabled()) {
            QStyle *style = QApplication::style();
            QStyleOptionButton so;
            QSize size = style->sizeFromContents(QStyle::CT_CheckBox, &so, QSize(), 0);
            const QPixmap pixmap = KisIconUtils::loadIcon("warning").pixmap(size);
            return pixmap;
        }
    }
 
    return BaseKoIDCategorizedListModel::data(idx, role);
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::data(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isEnabled(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), and KisIconUtils::loadIcon().

entryToString()

virtual QString KisCompositeOpListModel::entryToString ( const KoID & val ) const

inlinevirtual

Definition at line 30 of file kis_composite_ops_model.h.

{ return val.name(); }

References KoID::name().

favoriteCategory()

KoID KisCompositeOpListModel::favoriteCategory ( )

static

Definition at line 21 of file kis_composite_ops_model.cc.

                                               {
    static KoID category("favorites", ki18n("Favorites"));
    return category;
}

initialize()

void KisCompositeOpListModel::initialize

(

)

Definition at line 26 of file kis_composite_ops_model.cc.

{
    auto ops = KoCompositeOpRegistry::instance().getCompositeOps();
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    QMapIterator<KoID, KoID> it(ops);
#else
    QMultiMapIterator<KoID, KoID> it(ops);
#endif
 
 
    while (it.hasNext()) {
        KoID op = *it.next();
        KoID category = it.key();
        BaseKoIDCategorizedListModel::DataItem *item = categoriesMapper()->addEntry(category.name(), op);
        item->setCheckable(true);
    }
 
    BaseKoIDCategorizedListModel::DataItem *item = categoriesMapper()->addCategory(favoriteCategory().name());
    item->setExpanded(true);
 
    readFavoriteCompositeOpsFromConfig();
}

References KisCategoriesMapper< TEntry, TEntryToQStringConverter >::addCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::addEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), favoriteCategory(), KoCompositeOpRegistry::getCompositeOps(), KoCompositeOpRegistry::instance(), KoID::name(), readFavoriteCompositeOpsFromConfig(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setCheckable(), and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setExpanded().

initializeForLayerStyles()

void KisCompositeOpListModel::initializeForLayerStyles

(

)

Definition at line 49 of file kis_composite_ops_model.cc.

{
    auto ops = KoCompositeOpRegistry::instance().getLayerStylesCompositeOps();
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
    QMapIterator<KoID, KoID> it(ops);
#else
    QMultiMapIterator<KoID, KoID> it(ops);
#endif
 
 
    while (it.hasNext()) {
        KoID op = *it.next();
        KoID category = it.key();
        BaseKoIDCategorizedListModel::DataItem *item = categoriesMapper()->addEntry(category.name(), op);
        item->setCheckable(false);
    }
 
   categoriesMapper()->expandAllCategories();
}

References KisCategoriesMapper< TEntry, TEntryToQStringConverter >::addEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::expandAllCategories(), KoCompositeOpRegistry::getLayerStylesCompositeOps(), KoCompositeOpRegistry::instance(), KoID::name(), and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setCheckable().

readFavoriteCompositeOpsFromConfig()

void KisCompositeOpListModel::readFavoriteCompositeOpsFromConfig

(

)

Definition at line 147 of file kis_composite_ops_model.cc.

{
    KisConfig config(true);
    Q_FOREACH (const QString &op, config.favoriteCompositeOps()) {
        KoID entry = KoCompositeOpRegistry::instance().getKoID(op);
 
        DataItem *item = categoriesMapper()->fetchOneEntry(entry);
        if (item) {
            item->setChecked(true);
        }
 
        addFavoriteEntry(entry);
    }
}

References addFavoriteEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisConfig::favoriteCompositeOps(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::fetchOneEntry(), KoCompositeOpRegistry::getKoID(), KoCompositeOpRegistry::instance(), and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setChecked().

removeFavoriteEntry()

void KisCompositeOpListModel::removeFavoriteEntry ( const KoID & entry )

private

Definition at line 142 of file kis_composite_ops_model.cc.

{
    categoriesMapper()->removeEntry(favoriteCategory().name(), entry);
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), favoriteCategory(), and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::removeEntry().

setData()

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

override

Definition at line 93 of file kis_composite_ops_model.cc.

{
    if (!idx.isValid()) return false;
 
    bool result = BaseKoIDCategorizedListModel::setData(idx, value, role);
 
    DataItem *item = categoriesMapper()->itemFromRow(idx.row());
    Q_ASSERT(item);
 
 
    if(role == Qt::CheckStateRole) {
        if (item->isChecked()) {
            addFavoriteEntry(*item->data());
        } else {
            removeFavoriteEntry(*item->data());
        }
 
        writeFavoriteCompositeOpsToConfig();
    }
 
    return result;
}

References addFavoriteEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::data(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isChecked(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), removeFavoriteEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::setData(), value(), and writeFavoriteCompositeOpsToConfig().

sharedInstance()

KisCompositeOpListModel * KisCompositeOpListModel::sharedInstance ( )

static

Definition at line 69 of file kis_composite_ops_model.cc.

{
    static KisCompositeOpListModel *model = 0;
 
    if (!model) {
        model = new KisCompositeOpListModel();
        model->initialize();
    }
 
    return model;
}

References initialize().

validate()

void KisCompositeOpListModel::validate

(

const KoColorSpace *

cs

)

Definition at line 81 of file kis_composite_ops_model.cc.

{
    for (int i = 0, size = categoriesMapper()->rowCount(); i < size; i++) {
        DataItem *item = categoriesMapper()->itemFromRow(i);
 
        if (!item->isCategory()) {
            bool value = KoCompositeOpRegistry::instance().colorSpaceHasCompositeOp(cs, *item->data());
            item->setEnabled(value);
        }
    }
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KoCompositeOpRegistry::colorSpaceHasCompositeOp(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::data(), KoCompositeOpRegistry::instance(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::rowCount(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setEnabled(), and value().

writeFavoriteCompositeOpsToConfig()

void KisCompositeOpListModel::writeFavoriteCompositeOpsToConfig

(

)

const

Definition at line 162 of file kis_composite_ops_model.cc.

{
    QStringList list;
    QVector<DataItem*> filteredItems =
        categoriesMapper()->itemsForCategory(favoriteCategory().name());
 
    Q_FOREACH (DataItem *item, filteredItems) {
        list.append(item->data()->id());
    }
 
    KisConfig config(false);
    config.setFavoriteCompositeOps(list);
}

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::data(), favoriteCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemsForCategory(), and KisConfig::setFavoriteCompositeOps().

---

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

• libs/ui/kis_composite_ops_model.h
• libs/ui/kis_composite_ops_model.cc