Class: QgsLayoutViewRectangularRubberBand

class qgis.gui.QgsLayoutViewRectangularRubberBand

Bases: QgsLayoutViewRubberBand

QgsLayoutViewRectangularRubberBand is rectangular rubber band for use within QgsLayoutView widgets.

New in version 3.0.

QgsLayoutViewRectangularRubberBand(view: QgsLayoutView = None) Constructor for QgsLayoutViewRectangularRubberBand.

Methods

childEvent

connectNotify

create

param view:

customEvent

disconnectNotify

finish

param position:

isSignalConnected

receivers

sender

senderSignalIndex

start

param position:

timerEvent

update

param position:

updateRect

Calculates an updated bounding box rectangle from a original start position and new position.

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
create(self, view: QgsLayoutView) QgsLayoutViewRectangularRubberBand
Parameters:

view (QgsLayoutView) –

Return type:

QgsLayoutViewRectangularRubberBand

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
finish(self, position: QPointF | QPoint = QPointF(), modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier = Qt.KeyboardModifiers()) QRectF
Parameters:
  • position (Union[QPointF) –

  • modifiers (Union[Qt.KeyboardModifiers) –

Return type:

QRectF

isSignalConnected(self, QMetaMethod) bool
receivers(self, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
start(self, position: QPointF | QPoint, modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier)
Parameters:
  • position (Union[QPointF) –

  • modifiers (Union[Qt.KeyboardModifiers) –

timerEvent(self, QTimerEvent)
update(self, position: QPointF | QPoint, modifiers: Qt.KeyboardModifiers | Qt.KeyboardModifier)
Parameters:
  • position (Union[QPointF) –

  • modifiers (Union[Qt.KeyboardModifiers) –

updateRect(self, start: QPointF | QPoint, position: QPointF | QPoint, constrainSquare: bool, fromCenter: bool) QRectF

Calculates an updated bounding box rectangle from a original start position and new position. If constrainSquare is True then the bounding box will be forced to a square shape. If fromCenter is True then the original start position will form the center point of the returned rectangle.