Class: QgsLayoutComboBox¶

A combobox which displays available layouts from a QgsLayoutManager.

Added in version 3.8.

QgsLayoutComboBox in the collapsed state¶

QgsLayoutComboBox in the expanded state¶

Class Hierarchy¶

Base classes¶

QComboBox
QWidget
QObject
QPaintDevice

class qgis.gui.QgsLayoutComboBox[source]¶

Bases: QComboBox

__init__(parent: QWidget | None = None, manager: QgsLayoutManager | None = None)

QgsLayoutComboBox creates a combo box to display a list of items in a layout manager. The layouts can optionally be filtered by type.

Parameters:

parent (Optional[QWidget] = None)
manager (Optional[QgsLayoutManager] = None)

allowEmptyLayout(self) → bool[source]¶

Returns True if the combobox includes the empty layout (“not set”) choice.

See also

setAllowEmptyLayout()

Return type:: bool

currentLayout(self) → QgsMasterLayoutInterface | None[source]¶

Returns the layout currently selected in the combo box.

Return type:: Optional[QgsMasterLayoutInterface]

filters(self) → QgsLayoutManagerProxyModel.Filters[source]¶

Returns the current filters used for filtering available layouts.

See also

setFilters()

Return type:: QgsLayoutManagerProxyModel.Filters

layout(self, index: int) → QgsMasterLayoutInterface | None[source]¶

Returns the layout at the specified index.

Parameters:: index (int)
Return type:: Optional[QgsMasterLayoutInterface]

signal layoutChanged[source]¶

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

setAllowEmptyLayout(self, allowEmpty: bool)[source]¶