QgsLayoutViewRectangularRubberBand Class Reference

A rectangular rubber band for use within QgsLayoutView widgets. More...

#include <qgslayoutviewrubberband.h>

Inheritance diagram for QgsLayoutViewRectangularRubberBand:

Public Member Functions
	QgsLayoutViewRectangularRubberBand (QgsLayoutView *view=nullptr)
	Constructor for QgsLayoutViewRectangularRubberBand.
	~QgsLayoutViewRectangularRubberBand () override
QgsLayoutViewRectangularRubberBand *	create (QgsLayoutView *view) const override
	Creates a new instance of the QgsLayoutViewRubberBand subclass.
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.
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).
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).
Public Member Functions inherited from QgsLayoutViewRubberBand
	QgsLayoutViewRubberBand (QgsLayoutView *view=nullptr)
	Constructor for QgsLayoutViewRubberBand.
	~QgsLayoutViewRubberBand () override=default
QBrush	brush () const
	Returns the brush used for drawing the rubber band.
QgsLayout *	layout () const
	Returns the layout associated with the rubber band.
QPen	pen () const
	Returns the pen used for drawing the rubber band.
void	setBrush (const QBrush &brush)
	Sets the brush used for drawing the rubber band.
void	setPen (const QPen &pen)
	Sets the pen used for drawing the rubber band.
QgsLayoutView *	view () const
	Returns the view associated with the rubber band.

Additional Inherited Members
Signals inherited from QgsLayoutViewRubberBand
void	sizeChanged (const QString &size)
	Emitted when the size of the rubber band is changed.
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.

Detailed Description

A rectangular rubber band for use within QgsLayoutView widgets.

Definition at line 153 of file qgslayoutviewrubberband.h.

Constructor & Destructor Documentation

QgsLayoutViewRectangularRubberBand()

QgsLayoutViewRectangularRubberBand::QgsLayoutViewRectangularRubberBand

(

QgsLayoutView *

view = nullptr

)

Constructor for QgsLayoutViewRectangularRubberBand.

Definition at line 128 of file qgslayoutviewrubberband.cpp.

~QgsLayoutViewRectangularRubberBand()

QgsLayoutViewRectangularRubberBand::~QgsLayoutViewRectangularRubberBand ( )

override

Definition at line 138 of file qgslayoutviewrubberband.cpp.

Member Function Documentation

create()

QgsLayoutViewRectangularRubberBand * QgsLayoutViewRectangularRubberBand::create ( QgsLayoutView * view ) const

overridevirtual

Creates a new instance of the QgsLayoutViewRubberBand subclass.

Implements QgsLayoutViewRubberBand.

Definition at line 133 of file qgslayoutviewrubberband.cpp.

finish()

QRectF QgsLayoutViewRectangularRubberBand::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 180 of file qgslayoutviewrubberband.cpp.

start()

void QgsLayoutViewRectangularRubberBand::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 147 of file qgslayoutviewrubberband.cpp.

update()

void QgsLayoutViewRectangularRubberBand::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 161 of file qgslayoutviewrubberband.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/layout/qgslayoutviewrubberband.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/gui/layout/qgslayoutviewrubberband.cpp