qgsmodelgraphicsview.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelgraphicsview.h
                             -----------------------
    Date                 : March 2020
    Copyright            : (C) 2020 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 QGSMODELGRAPHICVIEW_H
#define QGSMODELGRAPHICVIEW_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsmodelsnapper.h"
#include "qgsprocessingcontext.h"
 
#include <QGraphicsRectItem>
#include <QGraphicsView>
 
class QgsModelViewTool;
class QgsModelViewToolTemporaryKeyPan;
class QgsModelViewToolTemporaryKeyZoom;
class QgsModelViewToolTemporaryMousePan;
class QgsModelComponentGraphicItem;
class QgsModelGraphicsScene;
class QgsModelViewSnapMarker;


class GUI_EXPORT QgsModelGraphicsView : public QGraphicsView
{
    Q_OBJECT
 
  public:
    QgsModelGraphicsView( QWidget *parent = nullptr );
    ~QgsModelGraphicsView() override;
 
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
    void dragMoveEvent( QDragMoveEvent *event ) override;
    void wheelEvent( QWheelEvent *event ) override;
    void mousePressEvent( QMouseEvent *event ) override;
    void mouseReleaseEvent( QMouseEvent *event ) override;
    void mouseMoveEvent( QMouseEvent *event ) override;
    void mouseDoubleClickEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;
    void keyReleaseEvent( QKeyEvent *event ) override;

    void setModelScene( QgsModelGraphicsScene *scene );

    QgsModelGraphicsScene *modelScene() const;

    QgsModelViewTool *tool() SIP_SKIP;

    void setTool( QgsModelViewTool *tool ) SIP_SKIP;

    void unsetTool( QgsModelViewTool *tool ) SIP_SKIP;

    QgsModelSnapper *snapper() SIP_SKIP;

    void startMacroCommand( const QString &text );

    void endMacroCommand();

    void beginCommand( const QString &text );

    void endCommand();

    void abortCommand();
 

    enum ClipboardOperation
    {
      ClipboardCut,  
      ClipboardCopy, 
    };

    void copySelectedItems( ClipboardOperation operation );

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

    enum PasteMode
    {
      PasteModeCursor,  
      PasteModeCenter,  
      PasteModeInPlace, 
    };

    void pasteItems( PasteMode mode );
 
  public slots:

    void snapSelected();
  signals:

    void algorithmDropped( const QString &algorithmId, const QPointF &pos );

    void inputDropped( const QString &inputId, const QPointF &pos );

    void toolSet( QgsModelViewTool *tool ) SIP_SKIP;

    void itemFocused( QgsModelComponentGraphicItem *item );

    void willBeDeleted();

    void macroCommandStarted( const QString &text );

    void macroCommandEnded();

    void commandBegun( const QString &text );

    void commandEnded();

    void commandAborted();

    void deleteSelectedItems();
 
  private:
    void wheelZoom( QWheelEvent *event );

    void scaleSafe( double scale );

    QPointF deltaForKeyEvent( QKeyEvent *event );

    void friendlySetSceneRect();
 
    QPointer<QgsModelViewTool> mTool;
 
    QgsModelViewToolTemporaryKeyPan *mSpacePanTool = nullptr;
    QgsModelViewToolTemporaryMousePan *mMidMouseButtonPanTool = nullptr;
    QgsModelViewToolTemporaryKeyZoom *mSpaceZoomTool = nullptr;
 
    QPoint mMouseCurrentXY;
 
    int mBlockScrollbarSignals = 0;
 
    QgsModelSnapper mSnapper;
    QgsModelViewSnapMarker *mSnapMarker = nullptr;
};
 

class GUI_EXPORT QgsModelViewSnapMarker : public QGraphicsRectItem
{
  public:
    QgsModelViewSnapMarker();
 
    void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override;
 
  private:
    int mSize = 0;
};
 

 
#endif // QGSMODELGRAPHICVIEW_H