Subgroup: Layout

Class: QgsLayoutProxyModel

class qgis.core.QgsLayoutProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

Allows for filtering a QgsLayoutModel by item type.

New in version 3.0: Methods

beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
blockSignals
buddy
canDropMimeData
canFetchMore
changePersistentIndex
changePersistentIndexList
childEvent
children
columnCount
connectNotify
createIndex
customEvent
data
decodeData
deleteLater
disconnect
disconnectNotify
dropMimeData
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
dynamicSortFilter
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
event
eventFilter
exceptedItemList Returns the list of specific items excluded from the model.
fetchMore
filterAcceptsColumn
filterAcceptsRow
filterCaseSensitivity
filterKeyColumn
filterRegExp
filterRole
filterType Returns the current item type filter, or QgsLayoutItemRegistry.LayoutItem if no item type filter is set.
findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
flags
hasChildren
hasIndex
headerData
index
inherits
insertColumn
insertColumns
insertRow
insertRows
installEventFilter
invalidate
invalidateFilter
isSignalConnected
isSortLocaleAware
isWidgetType
isWindowType
itemData
itemFromSourceIndex Returns the QgsLayoutItem corresponding to an index from the source QgsLayoutModel model.
killTimer
lessThan
mapFromSource
mapSelectionFromSource
mapSelectionToSource
mapToSource
match
metaObject
mimeData
mimeTypes
moveColumn
moveColumns
moveRow
moveRows
moveToThread
objectName
parent parent(self) -> QObject
persistentIndexList
property
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
receivers
removeColumn
removeColumns
removeEventFilter
removeRow
removeRows
resetInternalData
revert
roleNames
rowCount
sender
senderSignalIndex
setData
setDynamicSortFilter
setExceptedItemList Sets a list of specific items to exclude from the model.
setFilterCaseSensitivity
setFilterFixedString
setFilterKeyColumn
setFilterRegExp setFilterRegExp(self, str)
setFilterRole
setFilterType Sets the item type filter.
setFilterWildcard
setHeaderData
setItemData
setObjectName
setParent
setProperty
setSortCaseSensitivity
setSortLocaleAware
setSortRole
setSourceModel
sibling
signalsBlocked
sort
sortCaseSensitivity
sortColumn
sortOrder
sortRole
sourceLayerModel Returns the QgsLayoutModel used in this proxy model.
sourceModel
span
startTimer
submit
supportedDragActions
supportedDropActions
thread
timerEvent
tr

Attributes

HorizontalSortHint
NoLayoutChangeHint
VerticalSortHint
columnsAboutToBeInserted columnsAboutToBeInserted(self, QModelIndex, int, int) [signal]
columnsAboutToBeMoved columnsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
columnsAboutToBeRemoved columnsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
columnsInserted columnsInserted(self, QModelIndex, int, int) [signal]
columnsMoved columnsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
columnsRemoved columnsRemoved(self, QModelIndex, int, int) [signal]
dataChanged dataChanged(self, QModelIndex, QModelIndex, Iterable[int] = []) [signal]
destroyed destroyed(self, QObject = None) [signal]
layoutAboutToBeChanged layoutAboutToBeChanged(self, object = QList<QPersistentModelIndex>(), QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
layoutChanged layoutChanged(self, Iterable[QPersistentModelIndex] = [], QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
modelAboutToBeReset modelAboutToBeReset(self) [signal]
modelReset modelReset(self) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
rowsAboutToBeInserted rowsAboutToBeInserted(self, QModelIndex, int, int) [signal]
rowsAboutToBeMoved rowsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
rowsAboutToBeRemoved rowsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
rowsInserted rowsInserted(self, QModelIndex, int, int) [signal]
rowsMoved rowsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
rowsRemoved rowsRemoved(self, QModelIndex, int, int) [signal]
sourceModelChanged sourceModelChanged(self) [signal]
staticMetaObject
beginInsertColumns()
beginInsertRows()
beginMoveColumns()
beginMoveRows()
beginRemoveColumns()
beginRemoveRows()
beginResetModel()
changePersistentIndex()
changePersistentIndexList()
childEvent()
connectNotify()
createIndex()
customEvent()
decodeData()
disconnectNotify()
encodeData()
endInsertColumns()
endInsertRows()
endMoveColumns()
endMoveRows()
endRemoveColumns()
endRemoveRows()
endResetModel()
exceptedItemList(self) → List[QgsLayoutItem]

Returns the list of specific items excluded from the model.

filterAcceptsColumn()
filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) → bool
filterType(self) → QgsLayoutItemRegistry.ItemType

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

See also

setFilterType()

invalidateFilter()
isSignalConnected()
itemFromSourceIndex(self, sourceIndex: QModelIndex) → QgsLayoutItem

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

lessThan(self, left: QModelIndex, right: QModelIndex) → bool
persistentIndexList()
receivers()
resetInternalData()
sender()
senderSignalIndex()
setExceptedItemList(self, items: Iterable[QgsLayoutItem])

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

setFilterType(self, filter: QgsLayoutItemRegistry.ItemType)

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()

sourceLayerModel(self) → QgsLayoutModel

Returns the QgsLayoutModel used in this proxy model.

timerEvent()