A common interface for layout designer dialogs and widgets.
More...
#include <qgslayoutdesignerinterface.h>
|
| virtual void | close ()=0 |
| | Closes the layout designer. More...
|
| |
| virtual void | showRulers (bool visible)=0 |
| | Toggles whether or not the rulers should be visible in the designer. More...
|
| |
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.
- Since
- QGIS 3.0
Definition at line 53 of file qgslayoutdesignerinterface.h.
◆ StandardTool
Standard designer tools which are always available for use.
| Enumerator |
|---|
| ToolMoveItemContent | Move item content tool.
|
| ToolMoveItemNodes | Move item nodes tool.
|
Definition at line 70 of file qgslayoutdesignerinterface.h.
◆ QgsLayoutDesignerInterface()
| QgsLayoutDesignerInterface::QgsLayoutDesignerInterface |
( |
QObject * |
parent = nullptr | ) |
|
|
inline |
◆ actionsToolbar()
| virtual QToolBar* QgsLayoutDesignerInterface::actionsToolbar |
( |
| ) |
|
|
pure virtual |
◆ activateTool()
| virtual void QgsLayoutDesignerInterface::activateTool |
( |
StandardTool |
tool | ) |
|
|
pure virtual |
Activates a standard layout designer tool.
- Since
- QGIS 3.6
◆ addDockWidget()
| virtual void QgsLayoutDesignerInterface::addDockWidget |
( |
Qt::DockWidgetArea |
area, |
|
|
QDockWidget * |
dock |
|
) |
| |
|
pure virtual |
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.
- See also
- removeDockWidget()
- Since
- QGIS 3.4
◆ atlasMenu()
| virtual QMenu* QgsLayoutDesignerInterface::atlasMenu |
( |
| ) |
|
|
pure virtual |
◆ atlasPreviewEnabled()
| virtual bool QgsLayoutDesignerInterface::atlasPreviewEnabled |
( |
| ) |
const |
|
pure virtual |
◆ atlasToolbar()
| virtual QToolBar* QgsLayoutDesignerInterface::atlasToolbar |
( |
| ) |
|
|
pure virtual |
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()
-
navigationToolbar()
-
actionsToolbar()
- Since
- QGIS 3.4
◆ close
| virtual void QgsLayoutDesignerInterface::close |
( |
| ) |
|
|
pure virtualslot |
Closes the layout designer.
◆ editMenu()
| virtual QMenu* QgsLayoutDesignerInterface::editMenu |
( |
| ) |
|
|
pure virtual |
◆ itemsMenu()
| virtual QMenu* QgsLayoutDesignerInterface::itemsMenu |
( |
| ) |
|
|
pure virtual |
◆ layout()
| virtual QgsLayout* QgsLayoutDesignerInterface::layout |
( |
| ) |
|
|
pure virtual |
Returns the current layout displayed in the designer.
- See also
- view()
◆ layoutMenu()
| virtual QMenu* QgsLayoutDesignerInterface::layoutMenu |
( |
| ) |
|
|
pure virtual |
◆ layoutToolbar()
| virtual QToolBar* QgsLayoutDesignerInterface::layoutToolbar |
( |
| ) |
|
|
pure virtual |
◆ masterLayout()
Returns the master layout displayed in the designer.
- See also
- layout()
◆ messageBar()
| virtual QgsMessageBar* QgsLayoutDesignerInterface::messageBar |
( |
| ) |
|
|
pure virtual |
Returns the designer's message bar.
◆ navigationToolbar()
| virtual QToolBar* QgsLayoutDesignerInterface::navigationToolbar |
( |
| ) |
|
|
pure virtual |
◆ removeDockWidget()
| virtual void QgsLayoutDesignerInterface::removeDockWidget |
( |
QDockWidget * |
dock | ) |
|
|
pure virtual |
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()
- Since
- QGIS 3.4
◆ reportMenu()
| virtual QMenu* QgsLayoutDesignerInterface::reportMenu |
( |
| ) |
|
|
pure virtual |
◆ selectItems()
| virtual void QgsLayoutDesignerInterface::selectItems |
( |
const QList< QgsLayoutItem * > & |
items | ) |
|
|
pure virtual |
Selects the specified items.
◆ setAtlasPreviewEnabled()
| virtual void QgsLayoutDesignerInterface::setAtlasPreviewEnabled |
( |
bool |
enabled | ) |
|
|
pure virtual |
Toggles whether the atlas preview mode should be enabled in the designer.
- See also
- atlasPreviewEnabled()
- Since
- QGIS 3.4
◆ settingsMenu()
| virtual QMenu* QgsLayoutDesignerInterface::settingsMenu |
( |
| ) |
|
|
pure virtual |
◆ showItemOptions()
| virtual void QgsLayoutDesignerInterface::showItemOptions |
( |
QgsLayoutItem * |
item, |
|
|
bool |
bringPanelToFront = true |
|
) |
| |
|
pure virtual |
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.
- Since
- QGIS 3.4
◆ showRulers
| virtual void QgsLayoutDesignerInterface::showRulers |
( |
bool |
visible | ) |
|
|
pure virtualslot |
Toggles whether or not the rulers should be visible in the designer.
- Since
- QGIS 3.4
◆ view()
Returns the layout view utilized by the designer.
- See also
- layout()
◆ viewMenu()
| virtual QMenu* QgsLayoutDesignerInterface::viewMenu |
( |
| ) |
|
|
pure virtual |
◆ window()
| virtual QWidget* QgsLayoutDesignerInterface::window |
( |
| ) |
|
|
pure virtual |
Returns a pointer to the designer window.
- Since
- QGIS 3.4
The documentation for this class was generated from the following file:
