QGIS API Documentation  3.9.0-Master (224899f119)
Public Types | Public Slots | Public Member Functions | List of all members
QgsLayoutDesignerInterface Class Referenceabstract

A common interface for layout designer dialogs and widgets. More...

#include <qgslayoutdesignerinterface.h>

Inheritance diagram for QgsLayoutDesignerInterface:
Inheritance graph
[legend]

Public Types

enum  StandardTool { ToolMoveItemContent, ToolMoveItemNodes }
 Standard designer tools which are always available for use. More...
 

Public Slots

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...
 

Public Member Functions

 QgsLayoutDesignerInterface (QObject *parent=nullptr)
 Constructor for QgsLayoutDesignerInterface. More...
 
virtual QToolBar * actionsToolbar ()=0
 Returns a reference to the designer's "Actions" toolbar. More...
 
virtual void activateTool (StandardTool tool)=0
 Activates a standard layout designer tool. More...
 
virtual void addDockWidget (Qt::DockWidgetArea area, QDockWidget *dock)=0
 Adds a dock widget to the layout designer, in the specified dock area. More...
 
virtual QMenu * atlasMenu ()=0
 Returns a reference to the designer's "Atlas" menu. More...
 
virtual bool atlasPreviewEnabled () const =0
 Returns whether the atlas preview mode is enabled in the designer. More...
 
virtual QToolBar * atlasToolbar ()=0
 Returns a reference to the designer's "Atlas" toolbar. More...
 
virtual QMenu * editMenu ()=0
 Returns a reference to the designer's "Edit" menu. More...
 
virtual QMenu * itemsMenu ()=0
 Returns a reference to the designer's "Items" menu. More...
 
virtual QgsLayoutlayout ()=0
 Returns the current layout displayed in the designer. More...
 
virtual QMenu * layoutMenu ()=0
 Returns a reference to the designer's "Layout" menu. More...
 
virtual QToolBar * layoutToolbar ()=0
 Returns a reference to the designer's "Layout" toolbar. More...
 
virtual QgsMasterLayoutInterfacemasterLayout ()=0
 Returns the master layout displayed in the designer. More...
 
virtual QgsMessageBarmessageBar ()=0
 Returns the designer's message bar. More...
 
virtual QToolBar * navigationToolbar ()=0
 Returns a reference to the designer's "Navigation" toolbar. More...
 
virtual void removeDockWidget (QDockWidget *dock)=0
 Removes the specified dock widget from layout designer (without deleting it). More...
 
virtual QMenu * reportMenu ()=0
 Returns a reference to the designer's "Report" menu. More...
 
virtual void selectItems (const QList< QgsLayoutItem * > &items)=0
 Selects the specified items. More...
 
virtual void setAtlasPreviewEnabled (bool enabled)=0
 Toggles whether the atlas preview mode should be enabled in the designer. More...
 
virtual QMenu * settingsMenu ()=0
 Returns a reference to the designer's "Settings" menu. More...
 
virtual void showItemOptions (QgsLayoutItem *item, bool bringPanelToFront=true)=0
 Shows the configuration widget for the specified layout item. More...
 
virtual QgsLayoutViewview ()=0
 Returns the layout view utilized by the designer. More...
 
virtual QMenu * viewMenu ()=0
 Returns a reference to the designer's "View" menu. More...
 
virtual QWidget * window ()=0
 Returns a pointer to the designer window. More...
 

Detailed Description

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.

Member Enumeration Documentation

◆ 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.

Constructor & Destructor Documentation

◆ QgsLayoutDesignerInterface()

QgsLayoutDesignerInterface::QgsLayoutDesignerInterface ( QObject *  parent = nullptr)
inline

Constructor for QgsLayoutDesignerInterface.

Definition at line 79 of file qgslayoutdesignerinterface.h.

Member Function Documentation

◆ actionsToolbar()

virtual QToolBar* QgsLayoutDesignerInterface::actionsToolbar ( )
pure virtual

Returns a reference to the designer's "Actions" toolbar.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutToolbar()
navigationToolbar()
atlasToolbar()
Since
QGIS 3.4

◆ 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

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()
editMenu()
viewMenu()
itemsMenu()
reportMenu()
settingsMenu()
Since
QGIS 3.4

◆ atlasPreviewEnabled()

virtual bool QgsLayoutDesignerInterface::atlasPreviewEnabled ( ) const
pure virtual

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

See also
setAtlasPreviewEnabled()
Since
QGIS 3.4

◆ 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

Returns a reference to the designer's "Edit" menu.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutMenu()
viewMenu()
itemsMenu()
atlasMenu()
reportMenu()
settingsMenu()
Since
QGIS 3.4

◆ itemsMenu()

virtual QMenu* QgsLayoutDesignerInterface::itemsMenu ( )
pure virtual

Returns a reference to the designer's "Items" menu.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutMenu()
editMenu()
viewMenu()
atlasMenu()
reportMenu()
settingsMenu()
Since
QGIS 3.4

◆ 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

Returns a reference to the designer's "Layout" menu.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
editMenu()
viewMenu()
itemsMenu()
atlasMenu()
reportMenu()
settingsMenu()
Since
QGIS 3.4

◆ layoutToolbar()

virtual QToolBar* QgsLayoutDesignerInterface::layoutToolbar ( )
pure virtual

Returns a reference to the designer's "Layout" toolbar.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
navigationToolbar()
actionsToolbar()
atlasToolbar()
Since
QGIS 3.4

◆ masterLayout()

virtual QgsMasterLayoutInterface* QgsLayoutDesignerInterface::masterLayout ( )
pure virtual

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

Returns a reference to the designer's "Navigation" toolbar.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutToolbar()
actionsToolbar()
atlasToolbar()
Since
QGIS 3.4

◆ 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

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()
editMenu()
viewMenu()
itemsMenu()
atlasMenu()
settingsMenu()
Since
QGIS 3.4

◆ 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

Returns a reference to the designer's "Settings" menu.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutMenu()
editMenu()
viewMenu()
itemsMenu()
atlasMenu()
reportMenu()
Since
QGIS 3.4

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

virtual QgsLayoutView* QgsLayoutDesignerInterface::view ( )
pure virtual

Returns the layout view utilized by the designer.

See also
layout()

◆ viewMenu()

virtual QMenu* QgsLayoutDesignerInterface::viewMenu ( )
pure virtual

Returns a reference to the designer's "View" menu.

Note
See class documentation for notes regarding handling customization of designer dialogs.
See also
layoutMenu()
editMenu()
itemsMenu()
atlasMenu()
reportMenu()
settingsMenu()
Since
QGIS 3.4

◆ 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: