Class: QgsAnnotationItemBaseWidget

A base class for property widgets for annotation items.

All annotation item widgets should inherit from this base class.

Added in version 3.22.

Note

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

The following methods must be implemented: createItem(), updateItem()

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice

Abstract Methods

createItem	Creates a new item matching the settings defined in the widget.
updateItem	Updates an existing item to match the settings defined in the widget.

Methods

context	Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
itemId	Returns the associated annotation item id.
layer	Returns the associated annotation map layer.
renderedItemDetails	Retrieve rendered annotation details for the associated annotation, if available.
setItem	Sets the current item to show in the widget.
setItemId	Sets the associated annotation item id.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAnnotationItemBaseWidget. See the FAQ for more details.

focusDefaultWidget	Focuses the default widget for the page.
setContext	Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
setLayer	Sets the associated annotation map layer.
setNewItem	Attempts to update the widget to show the properties for the specified item.

Signals

itemChanged

Emitted when the annotation item definition in the widget is changed by the user.

class qgis.gui.QgsAnnotationItemBaseWidget

Bases: QgsPanelWidget

__init__(parent: QWidget | None)

Constructor for QgsAnnotationItemBaseWidget.

Parameters:

parent (Optional[QWidget])

context(self) → QgsSymbolWidgetContext

Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also

setContext()

Return type:

QgsSymbolWidgetContext

abstract createItem(self) → QgsAnnotationItem | None

Creates a new item matching the settings defined in the widget.

Return type:

Optional[QgsAnnotationItem]

virtual focusDefaultWidget(self)

Focuses the default widget for the page.

signal itemChanged

Emitted when the annotation item definition in the widget is changed by the user.

itemId(self) → str

Returns the associated annotation item id.

See also

setItemId()

Added in version 3.40.

Return type:

str

layer(self) → QgsAnnotationLayer | None

Returns the associated annotation map layer.

See also

setLayer()

Added in version 3.40.

Return type:

Optional[QgsAnnotationLayer]

renderedItemDetails(self) → QgsRenderedAnnotationItemDetails | None

Retrieve rendered annotation details for the associated annotation, if available.

Added in version 3.40.

Return type:

Optional[QgsRenderedAnnotationItemDetails]

virtual setContext(self, context: QgsSymbolWidgetContext)

Sets the context in which the widget is shown, e.g., the associated map canvas and expression contexts.

See also

context()

Parameters:

context (QgsSymbolWidgetContext)

setItem(self, item: QgsAnnotationItem | None) → bool

Sets the current item to show in the widget. If True is returned, item was an acceptable type for display in this widget and the widget has been updated to match item’s properties.

If False is returned, then the widget could not be successfully updated to show the properties of item.

Parameters:

item (Optional[QgsAnnotationItem])

Return type:

bool

setItemId(self, id: str | None)

Sets the associated annotation item id.

See also

itemId()

Added in version 3.40.

Parameters:

id (Optional[str])

virtual setLayer(self, layer: QgsAnnotationLayer | None)

Sets the associated annotation map layer.

See also

layer()

Added in version 3.40.

Parameters:

layer (Optional[QgsAnnotationLayer])

virtual setNewItem(self, item: QgsAnnotationItem | None) → bool

Attempts to update the widget to show the properties for the specified item.

Subclasses can override this if they support changing items in place.

Implementations must return True if the item was accepted and the widget was updated.

Parameters:

item (Optional[QgsAnnotationItem])

Return type:

bool

abstract updateItem(self, item: QgsAnnotationItem | None)

Updates an existing item to match the settings defined in the widget.

Parameters:

item (Optional[QgsAnnotationItem])