qgslayoutdesignerinterface.h

Go to the documentation of this file.

/***************************************************************************
    qgslayoutdesignerinterface.h
     ---------------------
    Date                 : July 2017
    Copyright            : (C) 2017 Nyall Dawson
    Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSLAYOUTDESIGNERINTERFACE_H
#define QGSLAYOUTDESIGNERINTERFACE_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgslayoutexporter.h"
#include <QObject>
 
class QgsLayout;
class QgsLayoutView;
class QgsLayoutItem;
class QgsMessageBar;
class QgsFeature;
class QgsMasterLayoutInterface;
class QMenu;
class QDockWidget;
class QToolBar;
 
class GUI_EXPORT QgsLayoutDesignerInterface: public QObject
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsLayoutDesignerInterface *>( sipCpp ) )
      sipType = sipType_QgsLayoutDesignerInterface;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:
 
    enum StandardTool
    {
      ToolMoveItemContent, 
      ToolMoveItemNodes, 
    };
 
    QgsLayoutDesignerInterface( QObject *parent SIP_TRANSFERTHIS = nullptr )
      : QObject( parent )
    {}
 
    virtual QgsLayout *layout() = 0;
 
    virtual QgsMasterLayoutInterface *masterLayout() = 0;
 
    virtual QWidget *window() = 0;
 
    virtual QgsLayoutView *view() = 0;
 
    virtual QgsMessageBar *messageBar() = 0;
 
    virtual void selectItems( const QList< QgsLayoutItem * > &items ) = 0;
 
    virtual void setAtlasPreviewEnabled( bool enabled ) = 0;
 
    virtual bool atlasPreviewEnabled() const = 0;
 
    virtual void setAtlasFeature( const QgsFeature &feature ) = 0;
 
    virtual void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true ) = 0;
 
    // Menus and toolbars
 
    virtual QMenu *layoutMenu() = 0;
 
    virtual QMenu *editMenu() = 0;
 
    virtual QMenu *viewMenu() = 0;
 
    virtual QMenu *itemsMenu() = 0;
 
    virtual QMenu *atlasMenu() = 0;
 
    virtual QMenu *reportMenu() = 0;
 
    virtual QMenu *settingsMenu() = 0;
 
    virtual QToolBar *layoutToolbar() = 0;
 
    virtual QToolBar *navigationToolbar() = 0;
 
    virtual QToolBar *actionsToolbar() = 0;
 
    virtual QToolBar *atlasToolbar() = 0;
 
    virtual void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dock ) = 0;
 
    virtual void removeDockWidget( QDockWidget *dock ) = 0;
 
    virtual void activateTool( StandardTool tool ) = 0;
 
    class ExportResults
    {
      public:
 
        QgsLayoutExporter::ExportResult result;
 
        QMap< QString, QgsLabelingResults * > labelingResults;
 
    };
 
    virtual QgsLayoutDesignerInterface::ExportResults *lastExportResults() const = 0 SIP_FACTORY;
 
  public slots:
 
    virtual void close() = 0;
 
    virtual void showRulers( bool visible ) = 0;
 
  signals:
 
    void layoutExported();
 
 
    void mapPreviewRefreshed( QgsLayoutItemMap *map );
 
};
 
#endif // QGSLAYOUTDESIGNERINTERFACE_H