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 withinQgsLayoutView
widgets.New in version 3.0.
- Parameters
view –
-
brush
(self) → QBrush¶ Returns the brush used for drawing the rubber band.
See also
See also
- Return type
QBrush
-
childEvent
()¶
-
connectNotify
()¶
-
create
(self, view: QgsLayoutView) → QgsLayoutViewRubberBand¶ Creates a new instance of the
QgsLayoutViewRubberBand
subclass.- Parameters
view (QgsLayoutView) –
- Return type
-
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.
- Parameters
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
- Return type
QRectF
-
isSignalConnected
()¶
-
layout
(self) → QgsLayout¶ Returns the layout associated with the rubber band.
See also
- Return type
-
pen
(self) → QPen¶ Returns the pen used for drawing the rubber band.
See also
See also
- Return type
QPen
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setBrush
(self, brush: Union[QBrush, QColor, Qt.GlobalColor, QGradient])¶ Sets the
brush
used for drawing the rubber band.See also
See also
- Parameters
brush (Union[QBrush) –
-
setPen
(self, pen: Union[QPen, QColor, Qt.GlobalColor, QGradient])¶ Sets the
pen
used for drawing the rubber band.See also
See also
- Parameters
pen (Union[QPen) –
-
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).- Parameters
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
-
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).- Parameters
position (Union[QPointF) –
modifiers (Union[Qt.KeyboardModifiers) –
-
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 newposition
. IfconstrainSquare
is true then the bounding box will be forced to a square shape. IffromCenter
is true then the originalstart
position will form the center point of the returned rectangle.- Parameters
start (Union[QPointF) –
position (Union[QPointF) –
constrainSquare (bool) –
fromCenter (bool) –
- Return type
QRectF
-
view
(self) → QgsLayoutView¶ Returns the view associated with the rubber band.
See also
- Return type