qgslayoutviewrubberband.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayoutviewrubberband.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 QGSLAYOUTVIEWRUBBERBAND_H
#define QGSLAYOUTVIEWRUBBERBAND_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QBrush>
#include <QObject>
#include <QPen>
 
class QgsLayoutView;
class QGraphicsRectItem;
class QGraphicsEllipseItem;
class QGraphicsPolygonItem;
class QgsLayout;

class GUI_EXPORT QgsLayoutViewRubberBand : public QObject
{
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsLayoutViewMouseEvent *>( sipCpp ) )
      sipType = sipType_QgsLayoutViewMouseEvent;
    else
      sipType = 0;
    SIP_END
#endif
 
  public:
    QgsLayoutViewRubberBand( QgsLayoutView *view = nullptr );
 
    ~QgsLayoutViewRubberBand() override = default;

    virtual QgsLayoutViewRubberBand *create( QgsLayoutView *view ) const = 0 SIP_FACTORY;

    virtual void start( QPointF position, Qt::KeyboardModifiers modifiers ) = 0;

    virtual void update( QPointF position, Qt::KeyboardModifiers modifiers ) = 0;

    virtual QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) = 0;

    QgsLayoutView *view() const;

    QgsLayout *layout() const;

    QBrush brush() const;

    void setBrush( const QBrush &brush );

    QPen pen() const;

    void setPen( const QPen &pen );
 
  signals:

    void sizeChanged( const QString &size );
 
  protected:
    QRectF updateRect( QPointF start, QPointF position, bool constrainSquare, bool fromCenter );
 
  private:
    QgsLayoutView *mView = nullptr;
 
    QBrush mBrush = Qt::NoBrush;
    QPen mPen = QPen( QBrush( QColor( 227, 22, 22, 200 ) ), 0 );
};
 

class GUI_EXPORT QgsLayoutViewRectangularRubberBand : public QgsLayoutViewRubberBand
{
    Q_OBJECT
 
  public:
    QgsLayoutViewRectangularRubberBand( QgsLayoutView *view = nullptr );
    QgsLayoutViewRectangularRubberBand *create( QgsLayoutView *view ) const override SIP_FACTORY;
 
    ~QgsLayoutViewRectangularRubberBand() override;
 
    void start( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    void update( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) override;
 
  private:
    QGraphicsRectItem *mRubberBandItem = nullptr;

    QPointF mRubberBandStartPos;
};

class GUI_EXPORT QgsLayoutViewEllipticalRubberBand : public QgsLayoutViewRubberBand
{
    Q_OBJECT
 
  public:
    QgsLayoutViewEllipticalRubberBand( QgsLayoutView *view = nullptr );
    QgsLayoutViewEllipticalRubberBand *create( QgsLayoutView *view ) const override SIP_FACTORY;
 
    ~QgsLayoutViewEllipticalRubberBand() override;
 
    void start( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    void update( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) override;
 
  private:
    QGraphicsEllipseItem *mRubberBandItem = nullptr;

    QPointF mRubberBandStartPos;
};

class GUI_EXPORT QgsLayoutViewTriangleRubberBand : public QgsLayoutViewRubberBand
{
    Q_OBJECT
 
  public:
    QgsLayoutViewTriangleRubberBand( QgsLayoutView *view = nullptr );
    QgsLayoutViewTriangleRubberBand *create( QgsLayoutView *view ) const override SIP_FACTORY;
 
    ~QgsLayoutViewTriangleRubberBand() override;
 
    void start( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    void update( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) override;
 
  private:
    QGraphicsPolygonItem *mRubberBandItem = nullptr;

    QPointF mRubberBandStartPos;
};
#endif // QGSLAYOUTVIEWRUBBERBAND_H