QGIS API Documentation  3.2.0-Bonn (bc43194)
Public Member Functions | Protected Member Functions | List of all members
QgsLayoutProxyModel Class Reference

Allows for filtering a QgsLayoutModel by item type. More...

#include <qgslayoutmodel.h>

Inheritance diagram for QgsLayoutProxyModel:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutProxyModel (QgsLayout *layout, QObject *parent=nullptr)
 Constructor for QgsLayoutProxyModelm, attached to the specified layout. More...
 
QList< QgsLayoutItem *> exceptedItemList () const
 Returns the list of specific items excluded from the model. More...
 
QgsLayoutItemRegistry::ItemType filterType () const
 Returns the current item type filter, or QgsLayoutItemRegistry::LayoutItem if no item type filter is set. More...
 
QgsLayoutItemitemFromSourceIndex (const QModelIndex &sourceIndex) const
 Returns the QgsLayoutItem corresponding to an index from the source QgsLayoutModel model. More...
 
void setExceptedItemList (const QList< QgsLayoutItem * > &items)
 Sets a list of specific items to exclude from the model. More...
 
void setFilterType (QgsLayoutItemRegistry::ItemType filter)
 Sets the item type filter. More...
 
QgsLayoutModelsourceLayerModel () const
 Returns the QgsLayoutModel used in this proxy model. More...
 

Protected Member Functions

bool filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const override
 
bool lessThan (const QModelIndex &left, const QModelIndex &right) const override
 

Detailed Description

Allows for filtering a QgsLayoutModel by item type.

Since
QGIS 3.0

Definition at line 306 of file qgslayoutmodel.h.

Constructor & Destructor Documentation

◆ QgsLayoutProxyModel()

QgsLayoutProxyModel::QgsLayoutProxyModel ( QgsLayout layout,
QObject *  parent = nullptr 
)

Constructor for QgsLayoutProxyModelm, attached to the specified layout.

Definition at line 955 of file qgslayoutmodel.cpp.

Member Function Documentation

◆ exceptedItemList()

QList< QgsLayoutItem * > QgsLayoutProxyModel::exceptedItemList ( ) const
inline

Returns the list of specific items excluded from the model.

See also
setExceptedItemList()

Definition at line 342 of file qgslayoutmodel.h.

◆ filterAcceptsRow()

bool QgsLayoutProxyModel::filterAcceptsRow ( int  sourceRow,
const QModelIndex &  sourceParent 
) const
overrideprotected

Definition at line 1008 of file qgslayoutmodel.cpp.

◆ filterType()

QgsLayoutItemRegistry::ItemType QgsLayoutProxyModel::filterType ( ) const
inline

Returns the current item type filter, or QgsLayoutItemRegistry::LayoutItem if no item type filter is set.

See also
setFilterType()

Definition at line 322 of file qgslayoutmodel.h.

◆ itemFromSourceIndex()

QgsLayoutItem * QgsLayoutProxyModel::itemFromSourceIndex ( const QModelIndex &  sourceIndex) const

Returns the QgsLayoutItem corresponding to an index from the source QgsLayoutModel model.

Definition at line 983 of file qgslayoutmodel.cpp.

◆ lessThan()

bool QgsLayoutProxyModel::lessThan ( const QModelIndex &  left,
const QModelIndex &  right 
) const
overrideprotected

Definition at line 969 of file qgslayoutmodel.cpp.

◆ setExceptedItemList()

void QgsLayoutProxyModel::setExceptedItemList ( const QList< QgsLayoutItem * > &  items)

Sets a list of specific items to exclude from the model.

See also
exceptedItemList()

Definition at line 999 of file qgslayoutmodel.cpp.

◆ setFilterType()

void QgsLayoutProxyModel::setFilterType ( QgsLayoutItemRegistry::ItemType  filter)

Sets the item type filter.

Only matching item types will be shown. Set filter to QgsLayoutItemRegistry::LayoutItem to show all item types.

See also
filterType()

Definition at line 993 of file qgslayoutmodel.cpp.

◆ sourceLayerModel()

QgsLayoutModel* QgsLayoutProxyModel::sourceLayerModel ( ) const
inline

Returns the QgsLayoutModel used in this proxy model.

Definition at line 347 of file qgslayoutmodel.h.


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