Subgroup: Layout

Class: QgsLayoutDesignerInterface¶

class qgis.gui.QgsLayoutDesignerInterface¶

Bases: PyQt5.QtCore.QObject

A common interface for layout designer dialogs and widgets.

Provides a common interface and stable API for layout designer dialogs and widgets. This interface can be used by plugins and scripts to interact with open layout designer dialogs.

New in version 3.0: Methods

`blockSignals`
`childEvent`
`children`
`close`	Closes the layout designer.
`connectNotify`
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`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]
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`layout`	Returns the current layout displayed in the designer.
`masterLayout`	Returns the master layout displayed in the designer.
`messageBar`	Returns the designer’s message bar.
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`selectItems`	Selects the specified `items`.
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`
`view`	Returns the layout view utilized by the designer.

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

childEvent()¶

close(self)¶: Closes the layout designer.

connectNotify()¶

customEvent()¶

disconnectNotify()¶

isSignalConnected()¶

layout(self) → QgsLayout¶: Returns the current layout displayed in the designer.

See also

view()

masterLayout(self) → QgsMasterLayoutInterface¶: Returns the master layout displayed in the designer.

See also

layout()

messageBar(self) → QgsMessageBar¶: Returns the designer’s message bar.

receivers()¶

selectItems(self, items: Iterable[QgsLayoutItem])¶: Selects the specified items.

sender()¶

senderSignalIndex()¶

timerEvent()¶

view(self) → QgsLayoutView¶: Returns the layout view utilized by the designer.

See also

layout()