Class: QgsLayoutManagerProxyModel

class qgis.core.QgsLayoutManagerProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

QSortFilterProxyModel subclass for QgsLayoutManagerModel

Added in version 3.8.

QgsLayoutManagerProxyModel(parent: Optional[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(f: QgsLayoutManagerProxyModel.Filters | QgsLayoutManagerProxyModel.Filter)
class Filters(a0: QgsLayoutManagerProxyModel.Filters)

Bases: sip.wrapper

baseClass

alias of QgsLayoutManagerProxyModel

beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
childEvent(self, a0: QChildEvent | None)
connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: Any = None) QModelIndex
customEvent(self, a0: QEvent | None)
decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) bool
disconnectNotify(self, signal: QMetaMethod)
encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
filterAcceptsColumn(self, source_column: int, source_parent: 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.

Added 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, signal: QMetaMethod) bool
lessThan(self, left: QModelIndex, right: QModelIndex) bool
Parameters:
  • left (QModelIndex)

  • right (QModelIndex)

Return type:

bool

persistentIndexList(self) List[QModelIndex]
receivers(self, signal: PYQT_SIGNAL) int
resetInternalData(self)
sender(self) QObject | None
senderSignalIndex(self) int
setFilterString(self, filter: str | None)

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

See also

filterString()

Added in version 3.12.

Parameters:

filter (Optional[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, a0: QTimerEvent | None)