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: Enums
Methods
Returns a reference to the designer’s “Actions” toolbar.
Activates a standard layout designer
tool
.Adds a
dock
widget to the layout designer, in the specified dockarea
.Returns a reference to the designer’s “Atlas” menu.
Returns whether the atlas preview mode is enabled in the designer.
Returns a reference to the designer’s “Atlas” toolbar.
Closes the layout designer.
Returns a reference to the designer’s “Edit” menu.
Returns a reference to the designer’s “Items” menu.
Returns the current layout displayed in the designer.
Returns a reference to the designer’s “Layout” menu.
Returns a reference to the designer’s “Layout” toolbar.
Returns the master layout displayed in the designer.
Returns the designer’s message bar.
Returns a reference to the designer’s “Navigation” toolbar.
Removes the specified
dock
widget from layout designer (without deleting it).Returns a reference to the designer’s “Report” menu.
Selects the specified
items
.Toggles whether the atlas preview mode should be
enabled
in the designer.Returns a reference to the designer’s “Settings” menu.
Shows the configuration widget for the specified layout
item
.Toggles whether or not the rulers should be
visible
in the designer.Returns the layout view utilized by the designer.
Returns a reference to the designer’s “View” menu.
Returns a pointer to the designer window.
Signals
Attributes
-
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
See also
See also
New in version 3.4.
-
activateTool
(self, tool: QgsLayoutDesignerInterface.StandardTool)¶ Activates a standard layout designer
tool
.New in version 3.6.
-
addDockWidget
(self, area: Qt.DockWidgetArea, dock: QDockWidget)¶ Adds a
dock
widget to the layout designer, in the specified dockarea
.Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
atlasPreviewEnabled
(self) → bool¶ Returns whether the atlas preview mode is enabled in the designer.
See also
New in version 3.4.
-
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
See also
See also
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
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
See also
See also
New in version 3.4.
-
masterLayout
(self) → QgsMasterLayoutInterface¶ Returns the master layout displayed in the designer.
See also
-
messageBar
(self) → QgsMessageBar¶ Returns the designer’s message bar.
Returns a reference to the designer’s “Navigation” toolbar.
Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
See also
See also
New in version 3.4.
-
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
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
selectItems
(self, items: Iterable[QgsLayoutItem])¶ Selects the specified
items
.
-
sender
()¶
-
senderSignalIndex
()¶
-
setAtlasPreviewEnabled
(self, enabled: bool)¶ Toggles whether the atlas preview mode should be
enabled
in the designer.See also
New in version 3.4.
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
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.
-
showRulers
(self, visible: bool)¶ Toggles whether or not the rulers should be
visible
in the designer.New in version 3.4.
-
timerEvent
()¶
-
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
See also
See also
See also
See also
See also
New in version 3.4.
-
window
(self) → QWidget¶ Returns a pointer to the designer window.
New in version 3.4.
-
class