16 #ifndef QGSLAYOUTDESIGNERINTERFACE_H
17 #define QGSLAYOUTDESIGNERINTERFACE_H
59 if ( qobject_cast<QgsLayoutDesignerInterface *>( sipCpp ) )
60 sipType = sipType_QgsLayoutDesignerInterface;
117 virtual void selectItems(
const QList< QgsLayoutItem * > &items ) = 0;
334 virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dock ) = 0;
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
A common interface for layout designer dialogs and widgets.
virtual void removeDockWidget(QDockWidget *dock)=0
Removes the specified dock widget from layout designer (without deleting it).
virtual QgsMasterLayoutInterface * masterLayout()=0
Returns the master layout displayed in the designer.
virtual QgsLayoutView * view()=0
Returns the layout view utilized by the designer.
virtual void showItemOptions(QgsLayoutItem *item, bool bringPanelToFront=true)=0
Shows the configuration widget for the specified layout item.
virtual QMenu * viewMenu()=0
Returns a reference to the designer's "View" menu.
virtual QMenu * settingsMenu()=0
Returns a reference to the designer's "Settings" menu.
virtual QgsMessageBar * messageBar()=0
Returns the designer's message bar.
virtual QgsLayout * layout()=0
Returns the current layout displayed in the designer.
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 void addDockWidget(Qt::DockWidgetArea area, QDockWidget *dock)=0
Adds a dock widget to the layout designer, in the specified dock area.
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 QMenu * itemsMenu()=0
Returns a reference to the designer's "Items" menu.
virtual void setAtlasPreviewEnabled(bool enabled)=0
Toggles whether the atlas preview mode should be enabled in the designer.
virtual void activateTool(StandardTool tool)=0
Activates a standard layout designer tool.
virtual void close()=0
Closes the layout designer.
QgsLayoutDesignerInterface(QObject *parent=nullptr)
Constructor for QgsLayoutDesignerInterface.
virtual void setAtlasFeature(const QgsFeature &feature)=0
Sets the specified feature as the current atlas feature.
virtual QToolBar * layoutToolbar()=0
Returns a reference to the designer's "Layout" toolbar.
virtual QToolBar * actionsToolbar()=0
Returns a reference to the designer's "Actions" toolbar.
virtual void showRulers(bool visible)=0
Toggles whether or not the rulers should be visible in the designer.
virtual QToolBar * navigationToolbar()=0
Returns a reference to the designer's "Navigation" toolbar.
virtual QMenu * editMenu()=0
Returns a reference to the designer's "Edit" menu.
virtual QWidget * window()=0
Returns a pointer to the designer window.
virtual QMenu * atlasMenu()=0
Returns a reference to the designer's "Atlas" menu.
StandardTool
Standard designer tools which are always available for use.
@ ToolMoveItemNodes
Move item nodes tool.
@ ToolMoveItemContent
Move item content tool.
virtual QMenu * layoutMenu()=0
Returns a reference to the designer's "Layout" menu.
Base class for graphical items within a QgsLayout.
A graphical widget to display and interact with QgsLayouts.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Interface for master layout type objects, such as print layouts and reports.
A bar for displaying non-blocking messages to the user.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)