Class: QgsLayoutManagerProxyModel

class qgis.core.QgsLayoutManagerProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

QSortFilterProxyModel subclass for QgsLayoutManagerModel

New in version 3.8.

QgsLayoutManagerProxyModel(parent: QObject = None) Constructor for QgsLayoutManagerProxyModel.

Methods

beginInsertColumns
beginInsertRows
beginMoveColumns
beginMoveRows
beginRemoveColumns
beginRemoveRows
beginResetModel
changePersistentIndex
changePersistentIndexList
childEvent
connectNotify
createIndex
customEvent
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
filterAcceptsColumn
filterAcceptsRow	param sourceRow:
filterString	Returns the current filter string, if set.
filters	Returns the current filters used for filtering available layouts.
invalidateFilter
isSignalConnected
lessThan	param left:
persistentIndexList
receivers
resetInternalData
sender
senderSignalIndex
setFilterString	Sets a filter string, such that only layouts with names containing the specified string will be shown.
setFilters	Sets the current filters used for filtering available layouts.
timerEvent

Attributes

FilterPrintLayouts
FilterReports

class Filter

Bases: int

FilterPrintLayouts = 2

FilterReports = 4

class Filters

class Filters(Union[QgsLayoutManagerProxyModel.Filters, QgsLayoutManagerProxyModel.Filter])

class Filters(QgsLayoutManagerProxyModel.Filters)

Bases: sip.wrapper

baseClass

alias of QgsLayoutManagerProxyModel

beginInsertColumns(self, QModelIndex, int, int)

beginInsertRows(self, QModelIndex, int, int)

beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) → bool

beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) → bool

beginRemoveColumns(self, QModelIndex, int, int)

beginRemoveRows(self, QModelIndex, int, int)

beginResetModel(self)

changePersistentIndex(self, QModelIndex, QModelIndex)

changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])

childEvent(self, QChildEvent)

connectNotify(self, QMetaMethod)

createIndex(self, int, int, object: object = 0) → QModelIndex

customEvent(self, QEvent)

decodeData(self, int, int, QModelIndex, QDataStream) → bool

disconnectNotify(self, QMetaMethod)

encodeData(self, Iterable[QModelIndex], QDataStream)

endInsertColumns(self)

endInsertRows(self)

endMoveColumns(self)

endMoveRows(self)

endRemoveColumns(self)

endRemoveRows(self)

endResetModel(self)

filterAcceptsColumn(self, int, QModelIndex) → bool

filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex) → bool

Parameters:

• sourceRow (int) –

• sourceParent (QModelIndex) –

Return type:

bool

filterString(self) → str

Returns the current filter string, if set.

See also

setFilterString()

New in version 3.12.

Return type:

str

filters(self) → QgsLayoutManagerProxyModel.Filters

Returns the current filters used for filtering available layouts.

See also

setFilters()

Return type:

QgsLayoutManagerProxyModel.Filters

invalidateFilter(self)

isSignalConnected(self, QMetaMethod) → bool

lessThan(self, left: QModelIndex, right: QModelIndex) → bool

Parameters:

• left (QModelIndex) –

• right (QModelIndex) –

Return type:

bool

persistentIndexList(self) → List[QModelIndex]

receivers(self, PYQT_SIGNAL) → int

resetInternalData(self)

sender(self) → QObject

senderSignalIndex(self) → int

setFilterString(self, filter: str)

Sets a filter string, such that only layouts with names containing the specified string will be shown.

See also

filterString()

New in version 3.12.

Parameters:

filter (str) –

setFilters(self, filters: QgsLayoutManagerProxyModel.Filters | QgsLayoutManagerProxyModel.Filter)

Sets the current filters used for filtering available layouts.

See also

filters()

Parameters:

filters (Union[QgsLayoutManagerProxyModel.Filters) –

timerEvent(self, QTimerEvent)