Class: QgsLayoutManagerProxyModel

QSortFilterProxyModel subclass for QgsLayoutManagerModel.

Added in version 3.8.

Class Hierarchy

Base classes

QSortFilterProxyModel
QAbstractProxyModel
QAbstractItemModel
QObject

Methods

filterString	Returns the current filter string, if set.
filters	Returns the current filters used for filtering available layouts.
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.

Attributes

FilterPrintLayouts
FilterReports

class qgis.core.QgsLayoutManagerProxyModel

Bases: QSortFilterProxyModel

__init__(parent: QObject | None = None)

Constructor for QgsLayoutManagerProxyModel.

Parameters:

parent (Optional[QObject] = None)

class Filter

Bases: int

FilterPrintLayouts = 2

FilterReports = 4

class Filters

class Filters(f: QgsLayoutManagerProxyModel.Filters | QgsLayoutManagerProxyModel.Filter)

class Filters(a0: QgsLayoutManagerProxyModel.Filters)

Bases: object

filterString(self) → str

Returns the current filter string, if set.

See also

setFilterString()

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

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, QgsLayoutManagerProxyModel.Filter])