Subgroup: Layout

Class: QgsLayoutDesignerInterface

class qgis.gui.QgsLayoutDesignerInterface(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsLayoutDesignerInterface.

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

childEvent
close Closes the layout designer.
connectNotify
customEvent
disconnectNotify
isSignalConnected
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.
receivers
selectItems Selects the specified items.
sender
senderSignalIndex
timerEvent
view Returns the layout view utilized by the designer.

Signals

Attributes

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()