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.

Note

Layout designer dialogs are transitory. They are created only on demand (when a user opens the dialog) and are deleted as soon as the user closes the dialog. There can be multiple designer dialogs open at any one time, and each is a separate instance of the dialog and QgsLayoutDesignerInterface. Accordingly, plugins must take care to react to newly created designer dialogs and apply their customizations to all newly created dialogs. This can be done by listening for the QgisInterface.layoutDesignerOpened signal. Plugins must also listen for the QgisInterface.layoutDesignerWillBeClosed signal and gracefully cleanup any customizations before the designer dialog is deleted.

New in version 3.0.

Parameters

parent

class StandardTool

Bases: int

ToolMoveItemContent = 0
ToolMoveItemNodes = 1
actionsToolbar(self) → QToolBar

Returns a reference to the designer’s “Actions” toolbar.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutToolbar()

See also

atlasToolbar()

New in version 3.4.

Return type

QToolBar

activateTool(self, tool: QgsLayoutDesignerInterface.StandardTool)

Activates a standard layout designer tool.

New in version 3.6.

Parameters

tool (QgsLayoutDesignerInterface.StandardTool) –

addDockWidget(self, area: Qt.DockWidgetArea, dock: QDockWidget)

Adds a dock widget to the layout designer, in the specified dock area.

Note

See class documentation for notes regarding handling customization of designer dialogs.

New in version 3.4.

Parameters
  • area (Qt.DockWidgetArea) –

  • dock (QDockWidget) –

atlasMenu(self) → QMenu

Returns a reference to the designer’s “Atlas” menu.

Note that this may not exist or may be hidden if the designer is in report mode.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

editMenu()

See also

viewMenu()

See also

itemsMenu()

See also

reportMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

atlasPreviewEnabled(self) → bool

Returns whether the atlas preview mode is enabled in the designer.

New in version 3.4.

Return type

bool

atlasToolbar(self) → QToolBar

Returns a reference to the designer’s “Atlas” toolbar.

Note that this toolbar may not exist or may be hidden if the designer is in report mode.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutToolbar()

See also

actionsToolbar()

New in version 3.4.

Return type

QToolBar

childEvent()
close(self)

Closes the layout designer.

connectNotify()
customEvent()
disconnectNotify()
editMenu(self) → QMenu

Returns a reference to the designer’s “Edit” menu.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

viewMenu()

See also

itemsMenu()

See also

atlasMenu()

See also

reportMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

isSignalConnected()
itemsMenu(self) → QMenu

Returns a reference to the designer’s “Items” menu.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

editMenu()

See also

viewMenu()

See also

atlasMenu()

See also

reportMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

layout(self) → QgsLayout

Returns the current layout displayed in the designer.

See also

view()

Return type

QgsLayout

layoutMenu(self) → QMenu

Returns a reference to the designer’s “Layout” menu.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

editMenu()

See also

viewMenu()

See also

itemsMenu()

See also

atlasMenu()

See also

reportMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

layoutToolbar(self) → QToolBar

Returns a reference to the designer’s “Layout” toolbar.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

actionsToolbar()

See also

atlasToolbar()

New in version 3.4.

Return type

QToolBar

masterLayout(self) → QgsMasterLayoutInterface

Returns the master layout displayed in the designer.

See also

layout()

Return type

QgsMasterLayoutInterface

messageBar(self) → QgsMessageBar

Returns the designer’s message bar.

Return type

QgsMessageBar

navigationToolbar(self) → QToolBar

Returns a reference to the designer’s “Navigation” toolbar.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutToolbar()

See also

actionsToolbar()

See also

atlasToolbar()

New in version 3.4.

Return type

QToolBar

receivers()
removeDockWidget(self, dock: QDockWidget)

Removes the specified dock widget from layout designer (without deleting it).

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

addDockWidget()

New in version 3.4.

Parameters

dock (QDockWidget) –

reportMenu(self) → QMenu

Returns a reference to the designer’s “Report” menu.

Note that this may not exist or may be hidden if the designer is not in report mode.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

editMenu()

See also

viewMenu()

See also

itemsMenu()

See also

atlasMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

selectItems(self, items: Iterable[QgsLayoutItem])

Selects the specified items.

Parameters

items (Iterable[QgsLayoutItem]) –

sender()
senderSignalIndex()
setAtlasPreviewEnabled(self, enabled: bool)

Toggles whether the atlas preview mode should be enabled in the designer.

New in version 3.4.

Parameters

enabled (bool) –

settingsMenu(self) → QMenu

Returns a reference to the designer’s “Settings” menu.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

editMenu()

See also

viewMenu()

See also

itemsMenu()

See also

atlasMenu()

See also

reportMenu()

New in version 3.4.

Return type

QMenu

showItemOptions(self, item: QgsLayoutItem, bringPanelToFront: bool = True)

Shows the configuration widget for the specified layout item.

If bringPanelToFront is True, then the item properties panel will be automatically shown and raised to the top of the interface.

New in version 3.4.

Parameters
showRulers(self, visible: bool)

Toggles whether or not the rulers should be visible in the designer.

New in version 3.4.

Parameters

visible (bool) –

timerEvent()
view(self) → QgsLayoutView

Returns the layout view utilized by the designer.

See also

layout()

Return type

QgsLayoutView

viewMenu(self) → QMenu

Returns a reference to the designer’s “View” menu.

Note

See class documentation for notes regarding handling customization of designer dialogs.

See also

layoutMenu()

See also

editMenu()

See also

itemsMenu()

See also

atlasMenu()

See also

reportMenu()

See also

settingsMenu()

New in version 3.4.

Return type

QMenu

window(self) → QWidget

Returns a pointer to the designer window.

New in version 3.4.

Return type

QWidget