Class: QgsLayoutViewRubberBand

class qgis.gui.QgsLayoutViewRubberBand(view: QgsLayoutView = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsLayoutViewRubberBand.

QgsLayoutViewRubberBand is an abstract base class for temporary rubber band items in various shapes, for use within QgsLayoutView widgets.

New in version 3.0: Enums

Methods

brush Returns the brush used for drawing the rubber band.
childEvent
connectNotify
create Creates a new instance of the QgsLayoutViewRubberBand subclass.
customEvent
disconnectNotify
finish Called when a rubber band use has finished and the rubber band is no longer required.
isSignalConnected
layout Returns the layout associated with the rubber band.
pen Returns the pen used for drawing the rubber band.
receivers
sender
senderSignalIndex
setBrush Sets the brush used for drawing the rubber band.
setPen Sets the pen used for drawing the rubber band.
start Called when a rubber band should be created at the specified starting position (in layout coordinate space).
timerEvent
update Called when a rubber band should be updated to reflect a temporary ending position (in layout coordinate space).
updateRect Calculates an updated bounding box rectangle from a original start position and new position.
view Returns the view associated with the rubber band.

Signals

sizeChanged Emitted when the size of the rubber band is changed.

Attributes

brush(self) → QBrush

Returns the brush used for drawing the rubber band.

See also

setBrush()

See also

pen()

childEvent()
connectNotify()
create(self, view: QgsLayoutView) → QgsLayoutViewRubberBand

Creates a new instance of the QgsLayoutViewRubberBand subclass.

customEvent()
disconnectNotify()
finish(self, position: Union[QPointF, QPoint] = QPointF(), modifiers: Union[Qt.KeyboardModifiers, Qt.KeyboardModifier] = 0) → QRectF

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.

isSignalConnected()
layout(self) → QgsLayout

Returns the layout associated with the rubber band.

See also

view()

pen(self) → QPen

Returns the pen used for drawing the rubber band.

See also

setPen()

See also

brush()

receivers()
sender()
senderSignalIndex()
setBrush(self, brush: Union[QBrush, QColor, Qt.GlobalColor, QGradient])

Sets the brush used for drawing the rubber band.

See also

brush()

See also

setPen()

setPen(self, pen: Union[QPen, QColor, Qt.GlobalColor, QGradient])

Sets the pen used for drawing the rubber band.

See also

pen()

See also

setBrush()

sizeChanged

Emitted when the size of the rubber band is changed. The size argument gives a translated string describing the new rubber band size, with a format which differs per subclass (e.g. rectangles may describe a size using width and height, while circles may describe a size by radius). [signal]

start(self, position: Union[QPointF, QPoint], modifiers: Union[Qt.KeyboardModifiers, Qt.KeyboardModifier])

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

timerEvent()
update(self, position: Union[QPointF, QPoint], modifiers: Union[Qt.KeyboardModifiers, Qt.KeyboardModifier])

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

updateRect(self, start: Union[QPointF, QPoint], position: Union[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.

view(self) → QgsLayoutView

Returns the view associated with the rubber band.

See also

layout()