qgslayoutviewtool.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutviewtool.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 QGSLAYOUTVIEWTOOL_H
#define QGSLAYOUTVIEWTOOL_H
 
#include "qgis_sip.h"
#include "qgis_gui.h"
#include <QCursor>
#include <QAction>
#include <QPointer>
 
class QMouseEvent;
class QWheelEvent;
class QKeyEvent;
class QgsLayoutView;
class QgsLayoutViewMouseEvent;
class QgsLayout;
class QgsLayoutItem;
 
#ifdef SIP_RUN
% ModuleHeaderCode
#include <qgslayoutviewtooladditem.h>
% End
#endif
 
class GUI_EXPORT QgsLayoutViewTool : public QObject
{
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsLayoutViewToolAddItem *>( sipCpp ) != NULL )
      sipType = sipType_QgsLayoutViewToolAddItem;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:
 
    enum Flag
    {
      FlagSnaps = 1 << 1,  
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    ~QgsLayoutViewTool() override;
 
    QgsLayoutViewTool::Flags flags() const;
 
    virtual void layoutMoveEvent( QgsLayoutViewMouseEvent *event );
 
    virtual void layoutDoubleClickEvent( QgsLayoutViewMouseEvent *event );
 
    virtual void layoutPressEvent( QgsLayoutViewMouseEvent *event );
 
    virtual void layoutReleaseEvent( QgsLayoutViewMouseEvent *event );
 
    virtual void wheelEvent( QWheelEvent *event );
 
    virtual void keyPressEvent( QKeyEvent *event );
 
    virtual void keyReleaseEvent( QKeyEvent *event );
 
    void setAction( QAction *action );
 
    QAction *action();
 
    void setCursor( const QCursor &cursor );
 
    virtual void activate();
 
    virtual void deactivate();
 
    QString toolName() const { return mToolName; }
 
    QgsLayoutView *view() const;
 
    QgsLayout *layout() const;
 
    virtual QList< QgsLayoutItem * > ignoredSnapItems() const;
 
  signals:
 
    void activated();
 
    void deactivated();
 
    void itemFocused( QgsLayoutItem *item );
 
  protected:
 
    void setFlags( QgsLayoutViewTool::Flags flags );
 
    QgsLayoutViewTool( QgsLayoutView *view SIP_TRANSFERTHIS, const QString &name );
 
    bool isClickAndDrag( QPoint startViewPoint, QPoint endViewPoint ) const;
 
  private:
 
    QgsLayoutView *mView = nullptr;
 
    QgsLayoutViewTool::Flags mFlags = QgsLayoutViewTool::Flags();
 
    QCursor mCursor = Qt::ArrowCursor;
 
    QPointer< QAction > mAction;
 
    QString mToolName;
 
    friend class TestQgsLayoutView;
 
};
 
#endif // QGSLAYOUTVIEWTOOL_H