qgsmodelviewtool.h

Go to the documentation of this file.

/***************************************************************************
                             qgsmodelviewtool.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 QGSMODELVIEWTOOL_H
#define QGSMODELVIEWTOOL_H
 
#include "qgis_sip.h"
#include "qgis_gui.h"
#include <QCursor>
#include <QAction>
#include <QPointer>
 
class QMouseEvent;
class QWheelEvent;
class QKeyEvent;
class QgsModelGraphicsView;
class QgsModelViewMouseEvent;
class QgsModelComponentGraphicItem;
class QgsModelGraphicsScene;
 
#define SIP_NO_FILE
 
class GUI_EXPORT QgsModelViewTool : public QObject
{
    Q_OBJECT
 
  public:
    enum Flag
    {
      FlagSnaps = 1 << 1, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    ~QgsModelViewTool() override;
 
    QgsModelViewTool::Flags flags() const;
 
    virtual void modelMoveEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelDoubleClickEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelPressEvent( QgsModelViewMouseEvent *event );
 
    virtual void modelReleaseEvent( QgsModelViewMouseEvent *event );
 
    virtual void wheelEvent( QWheelEvent *event );
 
    virtual void keyPressEvent( QKeyEvent *event );
 
    virtual void keyReleaseEvent( QKeyEvent *event );
 
    virtual bool allowItemInteraction();
 
    void setAction( QAction *action );
 
    QAction *action();
 
    void setCursor( const QCursor &cursor );
 
    virtual void activate();
 
    virtual void deactivate();
 
    QString toolName() const { return mToolName; }
 
    QgsModelGraphicsView *view() const;
 
    QgsModelGraphicsScene *scene() const;
 
  signals:
 
    void activated();
 
    void deactivated();
 
    void itemFocused( QgsModelComponentGraphicItem *item );
 
  protected:
    void setFlags( QgsModelViewTool::Flags flags );
 
    QgsModelViewTool( QgsModelGraphicsView *view SIP_TRANSFERTHIS, const QString &name );
 
    bool isClickAndDrag( QPoint startViewPoint, QPoint endViewPoint ) const;
 
  private:
    QgsModelGraphicsView *mView = nullptr;
 
    QgsModelViewTool::Flags mFlags = QgsModelViewTool::Flags();
 
    QCursor mCursor = Qt::ArrowCursor;
 
    QPointer<QAction> mAction;
 
    QString mToolName;
};
 
#endif // QGSMODELVIEWTOOL_H