Class: QgsRubberBandPreviewItem

Abstract interface for rendering custom preview overlays attached to a QgsRubberBand.

Added in version 4.4.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: render()

List of all members, including inherited members

Constructor

__init__

Abstract Methods

render

Renders the custom preview overlay using the specified render context.

Methods

rubberBand

Returns the rubber band associated with the item.
class qgis.gui.QgsRubberBandPreviewItem[source]

Bases: object

__init__(rubberBand: QgsRubberBand | None)

Constructor for a QgsRubberBandPreviewItem, attached to the specified rubberBand.

Parameters:

rubberBand (Optional[QgsRubberBand])

__init__(a0: QgsRubberBandPreviewItem)
Parameters:

a0 (QgsRubberBandPreviewItem)

abstract render(self, context: QgsRenderContext)[source]

Renders the custom preview overlay using the specified render context.

Parameters:

context (QgsRenderContext)

rubberBand(self) → QgsRubberBand | None[source]

Returns the rubber band associated with the item.

Return type:

Optional[QgsRubberBand]