qgslayoutview.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutview.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 QGSLAYOUTVIEW_H
#define QGSLAYOUTVIEW_H

#include "qgis_sip.h"
#include "qgsprevieweffect.h" // for QgsPreviewEffect::PreviewMode
#include "qgis_gui.h"
#include "qgslayoutitempage.h"
#include "qgslayoutaligner.h"
#include <QPointer>
#include <QGraphicsView>
#include <QGraphicsRectItem>
#include <memory>

class QMenu;
class QgsLayout;
class QgsLayoutViewTool;
class QgsLayoutViewToolTemporaryKeyPan;
class QgsLayoutViewToolTemporaryKeyZoom;
class QgsLayoutViewToolTemporaryMousePan;
class QgsLayoutRuler;
class QgsLayoutViewMenuProvider;
class QgsLayoutViewSnapMarker;
class QgsLayoutReportSectionLabel;

class GUI_EXPORT QgsLayoutView: public QGraphicsView
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsLayoutView *>( sipCpp ) )
      sipType = sipType_QgsLayoutView;
    else
      sipType = NULL;
    SIP_END
#endif

    Q_OBJECT

    Q_PROPERTY( QgsLayout *currentLayout READ currentLayout WRITE setCurrentLayout NOTIFY layoutSet )
    Q_PROPERTY( QgsLayoutViewTool *tool READ tool WRITE setTool NOTIFY toolSet )

  public:

    enum ClipboardOperation
    {
      ClipboardCut, 
      ClipboardCopy, 
    };

    enum PasteMode
    {
      PasteModeCursor, 
      PasteModeCenter, 
      PasteModeInPlace, 
    };

    QgsLayoutView( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    ~QgsLayoutView() override;

    QgsLayout *currentLayout();

    SIP_SKIP const QgsLayout *currentLayout() const;

    void setCurrentLayout( QgsLayout *layout SIP_KEEPREFERENCE );

    QgsLayoutViewTool *tool();

    void setTool( QgsLayoutViewTool *tool );

    void unsetTool( QgsLayoutViewTool *tool );

    void setPreviewModeEnabled( bool enabled );

    bool previewModeEnabled() const;

    void setPreviewMode( QgsPreviewEffect::PreviewMode mode );

    QgsPreviewEffect::PreviewMode previewMode() const;

    void scaleSafe( double scale );

    void setZoomLevel( double level );

    void setHorizontalRuler( QgsLayoutRuler *ruler );

    void setVerticalRuler( QgsLayoutRuler *ruler );

    void setMenuProvider( QgsLayoutViewMenuProvider *provider SIP_TRANSFER );

    QgsLayoutViewMenuProvider *menuProvider() const;

    int currentPage() const { return mCurrentPage; }

    QList< QgsLayoutItemPage * > visiblePages() const;

    QList< int > visiblePageNumbers() const;

    void alignSelectedItems( QgsLayoutAligner::Alignment alignment );

    void distributeSelectedItems( QgsLayoutAligner::Distribution distribution );

    void resizeSelectedItems( QgsLayoutAligner::Resize resize );

    void copySelectedItems( ClipboardOperation operation );

    void copyItems( const QList< QgsLayoutItem * > &items, ClipboardOperation operation );

    QList< QgsLayoutItem * > pasteItems( PasteMode mode );

    QList< QgsLayoutItem * > pasteItems( QPointF layoutPoint );

    bool hasItemsInClipboard() const;

    QPointF deltaForKeyEvent( QKeyEvent *event );

    void setPaintingEnabled( bool enabled ); SIP_SKIP

    void setSectionLabel( const QString &label );

  public slots:

    void zoomFull();

    void zoomWidth();

    void zoomIn();

    void zoomOut();

    void zoomActual();

    // NOTE - I realize these emitXXX methods are gross, but there's no clean
    // alternative here. We can't override the non-virtual Qt QGraphicsView
    // methods, and adding our own renamed methods which call the base class
    // methods also adds noise to the API.
    void emitZoomLevelChanged();

    // Why are these select methods in the view and not in the scene (QgsLayout)?
    // Well, in my opinion selections are purely a GUI concept. Ideally
    // NONE of the selection handling would be done in core, but we're restrained
    // by the QGraphicsScene API here.

    void selectAll();

    void deselectAll();

    void invertSelection();

    void selectNextItemAbove();

    void selectNextItemBelow();

    void raiseSelectedItems();

    void lowerSelectedItems();

    void moveSelectedItemsToTop();

    void moveSelectedItemsToBottom();

    void lockSelectedItems();

    void unlockAllItems();

    void deleteSelectedItems();

    void deleteItems( const QList< QgsLayoutItem * > &items );

    void groupSelectedItems();

    void ungroupSelectedItems();

    void viewChanged();

    void pushStatusMessage( const QString &message );

  signals:

    void layoutSet( QgsLayout *layout );

    void toolSet( QgsLayoutViewTool *tool );

    void zoomLevelChanged();

    void cursorPosChanged( QPointF layoutPoint );

    void pageChanged( int page );

    void statusMessage( const QString &message );

    void itemFocused( QgsLayoutItem *item );

    void willBeDeleted();

  protected:
    void mousePressEvent( QMouseEvent *event ) override;
    void mouseReleaseEvent( QMouseEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mouseDoubleClickEvent( QMouseEvent *event ) override;
    void wheelEvent( QWheelEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;
    void keyReleaseEvent( QKeyEvent *event ) override;
    void resizeEvent( QResizeEvent *event ) override;
    void scrollContentsBy( int dx, int dy ) override;
    void dragEnterEvent( QDragEnterEvent *e ) override;
    void paintEvent( QPaintEvent *event ) override;

  private slots:

    void invalidateCachedRenders();

  private:

    void wheelZoom( QWheelEvent *event );

    QPointer< QgsLayoutViewTool > mTool;

    QgsLayoutViewToolTemporaryKeyPan *mSpacePanTool = nullptr;
    QgsLayoutViewToolTemporaryMousePan *mMidMouseButtonPanTool = nullptr;
    QgsLayoutViewToolTemporaryKeyZoom *mSpaceZoomTool = nullptr;

    QPoint mMouseCurrentXY;

    QgsLayoutRuler *mHorizontalRuler = nullptr;
    QgsLayoutRuler *mVerticalRuler = nullptr;
    std::unique_ptr< QgsLayoutViewMenuProvider > mMenuProvider;

    QgsLayoutViewSnapMarker *mSnapMarker = nullptr;
    QgsLayoutReportSectionLabel *mSectionLabel = nullptr;

    QGraphicsLineItem *mHorizontalSnapLine = nullptr;
    QGraphicsLineItem *mVerticalSnapLine = nullptr;

    int mCurrentPage = 0;

    QgsPreviewEffect *mPreviewEffect = nullptr;

    bool mPaintingEnabled = true;

    friend class TestQgsLayoutView;
    friend class QgsLayoutMouseHandles;

    QGraphicsLineItem *createSnapLine() const;
};


class GUI_EXPORT QgsLayoutViewMenuProvider
{
  public:
    virtual ~QgsLayoutViewMenuProvider() = default;

    virtual QMenu *createContextMenu( QWidget *parent SIP_TRANSFER, QgsLayout *layout, QPointF layoutPoint ) const = 0 SIP_FACTORY;
};


#ifndef SIP_RUN


class GUI_EXPORT QgsLayoutViewSnapMarker : public QGraphicsRectItem
{
  public:

    QgsLayoutViewSnapMarker();

    void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;

  private:

    int mSize = 0;

};

#endif

#endif // QGSLAYOUTVIEW_H