QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
qgslayoutdesignerinterface.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutdesignerinterface.h
3  ---------------------
4  Date : July 2017
5  Copyright : (C) 2017 Nyall Dawson
6  Email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSLAYOUTDESIGNERINTERFACE_H
17 #define QGSLAYOUTDESIGNERINTERFACE_H
18 
19 #include "qgis_gui.h"
20 #include "qgis_sip.h"
21 #include "qgslayoutexporter.h"
22 #include <QObject>
23 
24 class QgsLayout;
25 class QgsLayoutView;
26 class QgsLayoutItem;
27 class QgsMessageBar;
28 class QgsFeature;
30 class QMenu;
31 class QDockWidget;
32 class QToolBar;
33 
54 class GUI_EXPORT QgsLayoutDesignerInterface: public QObject
55 {
56 
57 #ifdef SIP_RUN
59  if ( qobject_cast<QgsLayoutDesignerInterface *>( sipCpp ) )
60  sipType = sipType_QgsLayoutDesignerInterface;
61  else
62  sipType = NULL;
63  SIP_END
64 #endif
65 
66  Q_OBJECT
67 
68  public:
69 
72  {
75  };
76 
80  QgsLayoutDesignerInterface( QObject *parent SIP_TRANSFERTHIS = nullptr )
81  : QObject( parent )
82  {}
83 
88  virtual QgsLayout *layout() = 0;
89 
95 
101  virtual QWidget *window() = 0;
102 
107  virtual QgsLayoutView *view() = 0;
108 
112  virtual QgsMessageBar *messageBar() = 0;
113 
117  virtual void selectItems( const QList< QgsLayoutItem * > &items ) = 0;
118 
125  virtual void setAtlasPreviewEnabled( bool enabled ) = 0;
126 
133  virtual bool atlasPreviewEnabled() const = 0;
134 
140  virtual void setAtlasFeature( const QgsFeature &feature ) = 0;
141 
150  virtual void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true ) = 0;
151 
152  // Menus and toolbars
153 
168  virtual QMenu *layoutMenu() = 0;
169 
184  virtual QMenu *editMenu() = 0;
185 
200  virtual QMenu *viewMenu() = 0;
201 
216  virtual QMenu *itemsMenu() = 0;
217 
234  virtual QMenu *atlasMenu() = 0;
235 
252  virtual QMenu *reportMenu() = 0;
253 
268  virtual QMenu *settingsMenu() = 0;
269 
281  virtual QToolBar *layoutToolbar() = 0;
282 
294  virtual QToolBar *navigationToolbar() = 0;
295 
307  virtual QToolBar *actionsToolbar() = 0;
308 
323  virtual QToolBar *atlasToolbar() = 0;
324 
334  virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dock ) = 0;
335 
345  virtual void removeDockWidget( QDockWidget *dock ) = 0;
346 
352  virtual void activateTool( StandardTool tool ) = 0;
353 
360  {
361  public:
362 
367 
373  QMap< QString, QgsLabelingResults * > labelingResults;
374 
375  };
376 
385 
386  public slots:
387 
391  virtual void close() = 0;
392 
398  virtual void showRulers( bool visible ) = 0;
399 
400  signals:
401 
410 
411 
418 
419 };
420 
421 #endif // QGSLAYOUTDESIGNERINTERFACE_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Encapsulates the results of an export operation performed in the designer.
QMap< QString, QgsLabelingResults * > labelingResults
Returns the labeling results for all map items included in the export.
QgsLayoutExporter::ExportResult result
Result/error code of export.
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 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 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.
void mapPreviewRefreshed(QgsLayoutItemMap *map)
Emitted when a map item's preview has been refreshed.
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.
void layoutExported()
Emitted whenever a layout is exported from the layout designer.
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.
ExportResult
Result codes for exporting layouts.
Layout graphical items for displaying a map.
Base class for graphical items within a QgsLayout.
A graphical widget to display and interact with QgsLayouts.
Definition: qgslayoutview.h:50
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
Interface for master layout type objects, such as print layouts and reports.
A bar for displaying non-blocking messages to the user.
Definition: qgsmessagebar.h:61
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:191
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_END
Definition: qgis_sip.h:208