QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | List of all members
QgsLayoutViewEllipticalRubberBand Class Reference

QgsLayoutViewEllipseRubberBand is elliptical rubber band for use within QgsLayoutView widgets. More...

#include <qgslayoutviewrubberband.h>

Inheritance diagram for QgsLayoutViewEllipticalRubberBand:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutViewEllipticalRubberBand (QgsLayoutView *view=nullptr)
 Constructor for QgsLayoutViewEllipticalRubberBand. More...
 
 ~QgsLayoutViewEllipticalRubberBand () override
 
QgsLayoutViewEllipticalRubberBandcreate (QgsLayoutView *view) const override
 Creates a new instance of the QgsLayoutViewRubberBand subclass. More...
 
QRectF finish (QPointF position=QPointF(), Qt::KeyboardModifiers modifiers=Qt::KeyboardModifiers()) override
 Called when a rubber band use has finished and the rubber band is no longer required. More...
 
void start (QPointF position, Qt::KeyboardModifiers modifiers) override
 Called when a rubber band should be created at the specified starting position (in layout coordinate space). More...
 
void update (QPointF position, Qt::KeyboardModifiers modifiers) override
 Called when a rubber band should be updated to reflect a temporary ending position (in layout coordinate space). More...
 
- Public Member Functions inherited from QgsLayoutViewRubberBand
 QgsLayoutViewRubberBand (QgsLayoutView *view=nullptr)
 Constructor for QgsLayoutViewRubberBand. More...
 
 ~QgsLayoutViewRubberBand () override=default
 
QBrush brush () const
 Returns the brush used for drawing the rubber band. More...
 
QgsLayoutlayout () const
 Returns the layout associated with the rubber band. More...
 
QPen pen () const
 Returns the pen used for drawing the rubber band. More...
 
void setBrush (const QBrush &brush)
 Sets the brush used for drawing the rubber band. More...
 
void setPen (const QPen &pen)
 Sets the pen used for drawing the rubber band. More...
 
QgsLayoutViewview () const
 Returns the view associated with the rubber band. More...
 

Additional Inherited Members

- Signals inherited from QgsLayoutViewRubberBand
void sizeChanged (const QString &size)
 Emitted when the size of the rubber band is changed. More...
 
- Protected Member Functions inherited from QgsLayoutViewRubberBand
QRectF updateRect (QPointF start, QPointF position, bool constrainSquare, bool fromCenter)
 Calculates an updated bounding box rectangle from a original start position and new position. More...
 

Detailed Description

QgsLayoutViewEllipseRubberBand is elliptical rubber band for use within QgsLayoutView widgets.

Since
QGIS 3.0

Definition at line 192 of file qgslayoutviewrubberband.h.

Constructor & Destructor Documentation

◆ QgsLayoutViewEllipticalRubberBand()

QgsLayoutViewEllipticalRubberBand::QgsLayoutViewEllipticalRubberBand ( QgsLayoutView view = nullptr)

Constructor for QgsLayoutViewEllipticalRubberBand.

Definition at line 190 of file qgslayoutviewrubberband.cpp.

◆ ~QgsLayoutViewEllipticalRubberBand()

QgsLayoutViewEllipticalRubberBand::~QgsLayoutViewEllipticalRubberBand ( )
override

Definition at line 201 of file qgslayoutviewrubberband.cpp.

Member Function Documentation

◆ create()

QgsLayoutViewEllipticalRubberBand * QgsLayoutViewEllipticalRubberBand::create ( QgsLayoutView view) const
overridevirtual

Creates a new instance of the QgsLayoutViewRubberBand subclass.

Implements QgsLayoutViewRubberBand.

Definition at line 196 of file qgslayoutviewrubberband.cpp.

◆ finish()

QRectF QgsLayoutViewEllipticalRubberBand::finish ( QPointF  position = QPointF(),
Qt::KeyboardModifiers  modifiers = Qt::KeyboardModifiers() 
)
overridevirtual

Called when a rubber band use has finished and the rubber band is no longer required.

Returns the final bounding box of the rubber band.

Implements QgsLayoutViewRubberBand.

Definition at line 243 of file qgslayoutviewrubberband.cpp.

◆ start()

void QgsLayoutViewEllipticalRubberBand::start ( QPointF  position,
Qt::KeyboardModifiers  modifiers 
)
overridevirtual

Called when a rubber band should be created at the specified starting position (in layout coordinate space).

Implements QgsLayoutViewRubberBand.

Definition at line 210 of file qgslayoutviewrubberband.cpp.

◆ update()

void QgsLayoutViewEllipticalRubberBand::update ( QPointF  position,
Qt::KeyboardModifiers  modifiers 
)
overridevirtual

Called when a rubber band should be updated to reflect a temporary ending position (in layout coordinate space).

Implements QgsLayoutViewRubberBand.

Definition at line 224 of file qgslayoutviewrubberband.cpp.


The documentation for this class was generated from the following files: