KisCategorizedListModel< TEntry, TEntryToQStringConverter > Class Template Reference

#include <kis_categorized_list_model.h>

Inheritance diagram for KisCategorizedListModel< TEntry, TEntryToQStringConverter >:

Public Types
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 }

Public Member Functions
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

Private Attributes
SpecificCategoriesMapper	m_mapper

Detailed Description

template<class TEntry, class TEntryToQStringConverter>
class KisCategorizedListModel< TEntry, TEntryToQStringConverter >

Definition at line 57 of file kis_categorized_list_model.h.

Member Typedef Documentation

DataItem

template<class TEntry , class TEntryToQStringConverter >

typedef SpecificCategoriesMapper::DataItem KisCategorizedListModel< TEntry, TEntryToQStringConverter >::DataItem

Definition at line 62 of file kis_categorized_list_model.h.

Entry_Type

template<class TEntry , class TEntryToQStringConverter >

typedef TEntry KisCategorizedListModel< TEntry, TEntryToQStringConverter >::Entry_Type

Definition at line 60 of file kis_categorized_list_model.h.

SpecificCategoriesMapper

template<class TEntry , class TEntryToQStringConverter >

typedef KisCategoriesMapper<TEntry, TEntryToQStringConverter> KisCategorizedListModel< TEntry, TEntryToQStringConverter >::SpecificCategoriesMapper

Definition at line 61 of file kis_categorized_list_model.h.

Constructor & Destructor Documentation

KisCategorizedListModel()

template<class TEntry , class TEntryToQStringConverter >

KisCategorizedListModel< TEntry, TEntryToQStringConverter >::KisCategorizedListModel ( QObject * parent = 0 )

inline

Definition at line 65 of file kis_categorized_list_model.h.

        : __CategorizedListModelBase(parent)
    {
        connect(&m_mapper, SIGNAL(rowChanged(int)), SLOT(slotRowChanged(int))); // helps with category expand menu
        connect(&m_mapper, SIGNAL(beginInsertRow(int)), SLOT(slotBeginInsertRow(int)));
        connect(&m_mapper, SIGNAL(endInsertRow()), SLOT(slotEndInsertRow()));
        connect(&m_mapper, SIGNAL(beginRemoveRow(int)), SLOT(slotBeginRemoveRow(int)));
        connect(&m_mapper, SIGNAL(endRemoveRow()), SLOT(slotEndRemoveRow()));
 
 
 
    }

References connect(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, __CategorizedListModelBase::slotBeginInsertRow(), __CategorizedListModelBase::slotBeginRemoveRow(), __CategorizedListModelBase::slotEndInsertRow(), __CategorizedListModelBase::slotEndRemoveRow(), and __CategorizedListModelBase::slotRowChanged().

Member Function Documentation

categoriesMapper() [1/2]

template<class TEntry , class TEntryToQStringConverter >

SpecificCategoriesMapper * KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper ( )

inline

Definition at line 186 of file kis_categorized_list_model.h.

                                                 {
        return &m_mapper;
    }

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper.

categoriesMapper() [2/2]

template<class TEntry , class TEntryToQStringConverter >

const SpecificCategoriesMapper * KisCategorizedListModel< TEntry, TEntryToQStringConverter >::categoriesMapper ( ) const

inline

Definition at line 190 of file kis_categorized_list_model.h.

                                                             {
        return &m_mapper;
    }

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper.

data()

template<class TEntry , class TEntryToQStringConverter >

QVariant KisCategorizedListModel< TEntry, TEntryToQStringConverter >::data ( const QModelIndex & idx, int role = Qt::DisplayRole ) const

inlineoverride

Definition at line 83 of file kis_categorized_list_model.h.

                                                                                   {
        if (!idx.isValid()) return QVariant();
 
        typename SpecificCategoriesMapper::DataItem *item =
            m_mapper.itemFromRow(idx.row());
        Q_ASSERT(item);
 
        switch (role) {
        case IsHeaderRole:
            return item->isCategory();
        case ExpandCategoryRole:
            return item->isCategory() ? item->isExpanded() : item->parentCategory()->isExpanded();
        case Qt::ToolTipRole:
        case Qt::DisplayRole:
            return item->name();
        case Qt::CheckStateRole:
            return item->isCheckable() ? item->isChecked() ? Qt::Checked : Qt::Unchecked : QVariant();
        case SortRole:
            return item->isCategory() ? item->name() : item->parentCategory()->name() + item->name();
        case isLockedRole:
            return item->isLocked();
        case isLockableRole:
            return item->isLockable();
        case isToggledRole:
            return item->isToggled();
 
        }
 
        return QVariant();
    }

References __CategorizedListModelBase::ExpandCategoryRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCheckable(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isChecked(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isExpanded(), __CategorizedListModelBase::IsHeaderRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isLockable(), __CategorizedListModelBase::isLockableRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isLocked(), __CategorizedListModelBase::isLockedRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isToggled(), __CategorizedListModelBase::isToggledRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::name(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::parentCategory(), and __CategorizedListModelBase::SortRole.

entryAt()

template<class TEntry , class TEntryToQStringConverter >

bool KisCategorizedListModel< TEntry, TEntryToQStringConverter >::entryAt ( TEntry & entry, QModelIndex index ) const

inline

Definition at line 171 of file kis_categorized_list_model.h.

                                                         {
        int row = index.row();
        if (row < 0 || row >= m_mapper.rowCount()) return false;
 
        typename SpecificCategoriesMapper::DataItem *item =
            m_mapper.itemFromRow(row);
 
        if (!item->isCategory()) {
            entry = *item->data();
            return true;
        }
 
        return false;
    }

References KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::data(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::rowCount().

flags()

template<class TEntry , class TEntryToQStringConverter >

Qt::ItemFlags KisCategorizedListModel< TEntry, TEntryToQStringConverter >::flags ( const QModelIndex & idx ) const

inlineoverride

Definition at line 140 of file kis_categorized_list_model.h.

                                                             {
        if (!idx.isValid()) return Qt::NoItemFlags;
 
        typename SpecificCategoriesMapper::DataItem *item =
            m_mapper.itemFromRow(idx.row());
        Q_ASSERT(item);
 
        Qt::ItemFlags flags = Qt::NoItemFlags;
 
        if (item->isEnabled()) {
            flags |= Qt::ItemIsEnabled;
        }
 
        if (!item->isCategory()) {
            flags |= Qt::ItemIsSelectable;
 
            if (item->isCheckable()) {
                flags |= Qt::ItemIsUserCheckable;
            }
        }
 
        return flags;
    }

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::flags(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCheckable(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isEnabled(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), and KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper.

indexOf()

template<class TEntry , class TEntryToQStringConverter >

QModelIndex KisCategorizedListModel< TEntry, TEntryToQStringConverter >::indexOf ( const TEntry & entry ) const

inline

Definition at line 164 of file kis_categorized_list_model.h.

                                                   {
        typename SpecificCategoriesMapper::DataItem *item =
            m_mapper.fetchOneEntry(entry);
 
        return index(m_mapper.rowFromItem(item));
    }

References KisCategoriesMapper< TEntry, TEntryToQStringConverter >::fetchOneEntry(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::rowFromItem().

rowCount()

template<class TEntry , class TEntryToQStringConverter >

int KisCategorizedListModel< TEntry, TEntryToQStringConverter >::rowCount ( const QModelIndex & parent ) const

inlineoverride

Definition at line 78 of file kis_categorized_list_model.h.

                                                           {
        Q_UNUSED(parent);
        return m_mapper.rowCount();
    }

References KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, and KisCategoriesMapper< TEntry, TEntryToQStringConverter >::rowCount().

setData()

template<class TEntry , class TEntryToQStringConverter >

bool KisCategorizedListModel< TEntry, TEntryToQStringConverter >::setData ( const QModelIndex & idx, const QVariant & value, int role = Qt::EditRole )

inlineoverride

Definition at line 114 of file kis_categorized_list_model.h.

                                                                                                {
        if (!idx.isValid()) return false;
 
        typename SpecificCategoriesMapper::DataItem *item =
            m_mapper.itemFromRow(idx.row());
        Q_ASSERT(item);
 
        switch (role) {
        case ExpandCategoryRole:
            Q_ASSERT(item->isCategory());
            item->setExpanded(value.toBool());
            break;
        case Qt::CheckStateRole:
            Q_ASSERT(item->isCheckable());
            item->setChecked(value.toInt() == Qt::Checked);            
            break;        
        }
 
        // dataChanged() needs a QVector even though we are just passing one
        QVector<int> roles;
        roles.append(role);
 
        Q_EMIT dataChanged(idx, idx, roles);
        return true;
    }

References __CategorizedListModelBase::ExpandCategoryRole, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCategory(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::isCheckable(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::itemFromRow(), KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper, KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setChecked(), KisCategoriesMapper< TEntry, TEntryToQStringConverter >::DataItem::setExpanded(), and value().

Member Data Documentation

m_mapper

template<class TEntry , class TEntryToQStringConverter >

SpecificCategoriesMapper KisCategorizedListModel< TEntry, TEntryToQStringConverter >::m_mapper

private

Definition at line 195 of file kis_categorized_list_model.h.

---

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

• libs/ui/kis_categorized_list_model.h