KisModelIndexConverter Class Reference

#include <kis_model_index_converter.h>

Inheritance diagram for KisModelIndexConverter:

Public Member Functions
KisNodeDummy *	dummyFromIndex (QModelIndex index) override
KisNodeDummy *	dummyFromRow (int row, QModelIndex parent) override
bool	indexFromAddedDummy (KisNodeDummy *parentDummy, int index, const QString &newNodeMetaObjectType, QModelIndex &parentIndex, int &row) override
QModelIndex	indexFromDummy (KisNodeDummy *dummy) override
	KisModelIndexConverter (KisDummiesFacadeBase *dummiesFacade, KisNodeModel *model, bool showGlobalSelection)
int	rowCount (QModelIndex parent) override
Public Member Functions inherited from KisModelIndexConverterBase
virtual	~KisModelIndexConverterBase ()

Private Member Functions
bool	checkDummyMetaObjectType (const QString &type)
bool	checkDummyType (KisNodeDummy *dummy)

Private Attributes
KisDummiesFacadeBase *	m_dummiesFacade
KisNodeModel *	m_model
bool	m_showGlobalSelection

Detailed Description

The class for converting to/from QModelIndex and KisNodeDummy when the root node is hidden (ShowRootLayer == false). All the selection masks owned by the root layer are hidden as well.

Definition at line 22 of file kis_model_index_converter.h.

Constructor & Destructor Documentation

KisModelIndexConverter()

KisModelIndexConverter::KisModelIndexConverter	(	KisDummiesFacadeBase *	dummiesFacade,
		KisNodeModel *	model,
		bool	showGlobalSelection )

Definition at line 18 of file kis_model_index_converter.cpp.

    : m_dummiesFacade(dummiesFacade),
      m_model(model),
      m_showGlobalSelection(showGlobalSelection)
{
}

Member Function Documentation

checkDummyMetaObjectType()

bool KisModelIndexConverter::checkDummyMetaObjectType ( const QString & type )

inlineprivate

Definition at line 32 of file kis_model_index_converter.cpp.

{
    const QString selectionMaskType = KisSelectionMask::staticMetaObject.className();
    const QString referencesLayerType = KisReferenceImagesLayer::staticMetaObject.className();
    const QString decorationsLayerType = KisDecorationsWrapperLayer::staticMetaObject.className();
 
    return (type != selectionMaskType || m_showGlobalSelection) &&
            type != referencesLayerType &&
            type != decorationsLayerType;
}

References m_showGlobalSelection.

checkDummyType()

bool KisModelIndexConverter::checkDummyType ( KisNodeDummy * dummy )

inlineprivate

Definition at line 27 of file kis_model_index_converter.cpp.

{
    return dummy->isGUIVisible(m_showGlobalSelection);
}

References KisNodeDummy::isGUIVisible(), and m_showGlobalSelection.

dummyFromIndex()

KisNodeDummy * KisModelIndexConverter::dummyFromIndex ( QModelIndex index )

overridevirtual

Returns the dummy associated with the index WARNING: index must be valid

Note

cannot return null

Implements KisModelIndexConverterBase.

Definition at line 78 of file kis_model_index_converter.cpp.

{
    Q_ASSERT(index.isValid());
    Q_ASSERT(index.internalPointer());
    return static_cast<KisNodeDummy*>(index.internalPointer());
}

dummyFromRow()

KisNodeDummy * KisModelIndexConverter::dummyFromRow ( int row, QModelIndex parent )

overridevirtual

Returns the dummy staying in the specified row of a parent May return null in case of inconsistency

Implements KisModelIndexConverterBase.

Definition at line 43 of file kis_model_index_converter.cpp.

{
 
    KisNodeDummy *parentDummy = parent.isValid() ?
        dummyFromIndex(parent) : m_dummiesFacade->rootDummy();
 
    if(!parentDummy) return 0;
 
    KisNodeDummy *resultDummy = 0;
 
    // a child of the root node
    if(!parentDummy->parent()) {
        KisNodeDummy *currentDummy = parentDummy->lastChild();
        while(currentDummy) {
            if(checkDummyType(currentDummy)) {
                if(!row) {
                    resultDummy = currentDummy;
                    break;
                }
                row--;
            }
            currentDummy = currentDummy->prevSibling();
        }
    }
    // a child of other layer
    else {
        int rowCount = parentDummy->childCount();
        int index = rowCount - row - 1;
        resultDummy = parentDummy->at(index);
    }
 
 
    return resultDummy;
}

References KisNodeDummy::at(), checkDummyType(), KisNodeDummy::childCount(), dummyFromIndex(), KisNodeDummy::lastChild(), m_dummiesFacade, KisNodeDummy::parent(), KisNodeDummy::prevSibling(), KisDummiesFacadeBase::rootDummy(), and rowCount().

indexFromAddedDummy()

bool KisModelIndexConverter::indexFromAddedDummy ( KisNodeDummy * parentDummy, int index, const QString & newNodeMetaObjectType, QModelIndex & parentIndex, int & row )

overridevirtual

Calculates the parent and the position in the model for newly created dummy

Parameters

parentDummy	the dummy parent
index	the dummy index
newNodeMetaObjectType	is a class name of a newly added node This name is got from Qt's meta object system so you must compare this value against a corresponding staticMetaObject object only. We do not pass a pointer to a real node to limit the access to real nodes.
parentIndex	the parent index
row	the dummy row

Returns

whether the new dummy will be shown in the model

Implements KisModelIndexConverterBase.

Definition at line 117 of file kis_model_index_converter.cpp.

{
    // adding a root node
    if(!parentDummy) {
        Q_ASSERT(!index);
        return false;
    }
 
    // adding a child of the root node
    if(!parentDummy->parent()) {
        if(!checkDummyMetaObjectType(newNodeMetaObjectType)) {
            return false;
        }
 
        row = 0;
 
        parentIndex = QModelIndex();
        KisNodeDummy *dummy = parentDummy->lastChild();
        int toScan = parentDummy->childCount() - index;
        while(dummy && toScan > 0) {
            if(checkDummyType(dummy)) {
                row++;
            }
            dummy = dummy->prevSibling();
            toScan--;
        }
    }
    // everything else
    else {
        parentIndex = indexFromDummy(parentDummy);
        int rowCount = parentDummy->childCount();
        row = rowCount - index;
    }
 
    return true;
}

References checkDummyMetaObjectType(), checkDummyType(), KisNodeDummy::childCount(), indexFromDummy(), KisNodeDummy::lastChild(), KisNodeDummy::parent(), KisNodeDummy::prevSibling(), and rowCount().

indexFromDummy()

QModelIndex KisModelIndexConverter::indexFromDummy ( KisNodeDummy * dummy )

overridevirtual

Returns the index corresponding to the position of the dummy in the model. Will return invalid index if the dummy should be hidden

Implements KisModelIndexConverterBase.

Definition at line 85 of file kis_model_index_converter.cpp.

{
    Q_ASSERT(dummy);
    KisNodeDummy *parentDummy = dummy->parent();
 
    // a root node
    if(!parentDummy) return QModelIndex();
 
    int row = 0;
 
    // a child of the root node
    if(!parentDummy->parent()) {
        if(!checkDummyType(dummy)) return QModelIndex();
 
        KisNodeDummy *currentDummy = parentDummy->lastChild();
        while(currentDummy && currentDummy != dummy) {
            if(checkDummyType(currentDummy)) {
                row++;
            }
            currentDummy = currentDummy->prevSibling();
        }
    }
    // a child of other layer
    else {
        int rowCount = parentDummy->childCount();
        int index = parentDummy->indexOf(dummy);
        row = rowCount - index - 1;
    }
 
    return m_model->createIndex(row, 0, (void*)dummy);
}

References checkDummyType(), KisNodeDummy::childCount(), KisNodeDummy::indexOf(), KisNodeDummy::lastChild(), m_model, KisNodeDummy::parent(), KisNodeDummy::prevSibling(), and rowCount().

rowCount()

int KisModelIndexConverter::rowCount ( QModelIndex parent )

overridevirtual

Returns the number of children of the given index of the model

Implements KisModelIndexConverterBase.

Definition at line 158 of file kis_model_index_converter.cpp.

{
    KisNodeDummy *dummy = parent.isValid() ?
        dummyFromIndex(parent) : m_dummiesFacade->rootDummy();
 
    // a root node (hidden)
    if(!dummy) return 0;
 
    int numChildren = 0;
 
    // children of the root node
    if(!dummy->parent()) {
        KisNodeDummy *currentDummy = dummy->lastChild();
        while(currentDummy) {
            if(checkDummyType(currentDummy)) {
                numChildren++;
            }
 
            currentDummy = currentDummy->prevSibling();
        }
    }
    // children of other nodes
    else {
        numChildren = dummy->childCount();
    }
 
    return numChildren;
}

References checkDummyType(), KisNodeDummy::childCount(), dummyFromIndex(), KisNodeDummy::lastChild(), m_dummiesFacade, KisNodeDummy::parent(), KisNodeDummy::prevSibling(), and KisDummiesFacadeBase::rootDummy().

Member Data Documentation

m_dummiesFacade

KisDummiesFacadeBase* KisModelIndexConverter::m_dummiesFacade

private

Definition at line 44 of file kis_model_index_converter.h.

m_model

KisNodeModel* KisModelIndexConverter::m_model

private

Definition at line 45 of file kis_model_index_converter.h.

m_showGlobalSelection

bool KisModelIndexConverter::m_showGlobalSelection

private

Definition at line 46 of file kis_model_index_converter.h.

---

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

• libs/ui/kis_model_index_converter.h
• libs/ui/kis_model_index_converter.cpp