|
| QgsLayoutDesignerInterface (QObject *parent=nullptr) |
| Constructor for QgsLayoutDesignerInterface.
|
|
virtual QToolBar * | actionsToolbar ()=0 |
| Returns a reference to the designer's "Actions" toolbar.
|
|
virtual void | activateTool (StandardTool tool)=0 |
| Activates a standard layout designer tool.
|
|
virtual void | addDockWidget (Qt::DockWidgetArea area, QDockWidget *dock)=0 |
| Adds a dock widget to the layout designer, in the specified dock area.
|
|
virtual QMenu * | atlasMenu ()=0 |
| Returns a reference to the designer's "Atlas" menu.
|
|
virtual bool | atlasPreviewEnabled () const =0 |
| Returns whether the atlas preview mode is enabled in the designer.
|
|
virtual QToolBar * | atlasToolbar ()=0 |
| Returns a reference to the designer's "Atlas" toolbar.
|
|
virtual QMenu * | editMenu ()=0 |
| Returns a reference to the designer's "Edit" menu.
|
|
virtual QMenu * | itemsMenu ()=0 |
| Returns a reference to the designer's "Items" menu.
|
|
virtual QgsLayoutDesignerInterface::ExportResults * | lastExportResults () const =0 |
| Returns the results of the last export operation performed in the designer.
|
|
virtual QgsLayout * | layout ()=0 |
| Returns the current layout displayed in the designer.
|
|
virtual QMenu * | layoutMenu ()=0 |
| Returns a reference to the designer's "Layout" menu.
|
|
virtual QToolBar * | layoutToolbar ()=0 |
| Returns a reference to the designer's "Layout" toolbar.
|
|
virtual QgsMasterLayoutInterface * | masterLayout ()=0 |
| Returns the master layout displayed in the designer.
|
|
virtual QgsMessageBar * | messageBar ()=0 |
| Returns the designer's message bar.
|
|
virtual QToolBar * | navigationToolbar ()=0 |
| Returns a reference to the designer's "Navigation" toolbar.
|
|
virtual void | removeDockWidget (QDockWidget *dock)=0 |
| Removes the specified dock widget from layout designer (without deleting it).
|
|
virtual QMenu * | reportMenu ()=0 |
| Returns a reference to the designer's "Report" menu.
|
|
virtual void | selectItems (const QList< QgsLayoutItem * > &items)=0 |
| Selects the specified items.
|
|
virtual void | setAtlasFeature (const QgsFeature &feature)=0 |
| Sets the specified feature as the current atlas feature.
|
|
virtual void | setAtlasPreviewEnabled (bool enabled)=0 |
| Toggles whether the atlas preview mode should be enabled in the designer.
|
|
virtual QMenu * | settingsMenu ()=0 |
| Returns a reference to the designer's "Settings" menu.
|
|
virtual void | showItemOptions (QgsLayoutItem *item, bool bringPanelToFront=true)=0 |
| Shows the configuration widget for the specified layout item.
|
|
virtual QgsLayoutView * | view ()=0 |
| Returns the layout view utilized by the designer.
|
|
virtual QMenu * | viewMenu ()=0 |
| Returns a reference to the designer's "View" menu.
|
|
virtual QWidget * | window ()=0 |
| Returns a pointer to the designer window.
|
|
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.
Definition at line 54 of file qgslayoutdesignerinterface.h.