Class: QgsLayoutItemAbstractGuiMetadata

Stores GUI metadata about one layout item class.

This is a companion to QgsLayoutItemAbstractMetadata, storing only the components related to the GUI behavior of a layout item.

Note

In C++ you can use QgsLayoutItemGuiMetadata convenience class.

class qgis.gui.QgsLayoutItemAbstractGuiMetadata

Bases: object

__init__(type: int, visibleName: str | None, groupId: str | None = '', isNodeBased: bool = False, flags: QgsLayoutItemAbstractGuiMetadata.Flags | QgsLayoutItemAbstractGuiMetadata.Flag = QgsLayoutItemAbstractGuiMetadata.Flags())

Constructor for QgsLayoutItemAbstractGuiMetadata with the specified class type.

visibleName should be set to a translated, user visible name identifying the corresponding layout item.

An optional groupId can be set, which allows grouping of related layout item classes. See QgsLayoutItemGuiMetadata for details.

If isNodeBased is True, then the corresponding item is a node based item.

Parameters:

• type (int)

• visibleName (Optional[str])

• groupId (Optional[str] = '')

• isNodeBased (bool = False)

• flags (Union[QgsLayoutItemAbstractGuiMetadata.Flags, QgsLayoutItemAbstractGuiMetadata.Flag] = QgsLayoutItemAbstractGuiMetadata.Flags())

__init__(a0: QgsLayoutItemAbstractGuiMetadata)

Parameters:

a0 (QgsLayoutItemAbstractGuiMetadata)

class Flag

Bases: int

FlagNoCreationTools = 2

class Flags

class Flags(f: QgsLayoutItemAbstractGuiMetadata.Flags | QgsLayoutItemAbstractGuiMetadata.Flag)

class Flags(a0: QgsLayoutItemAbstractGuiMetadata.Flags)

Bases: object

virtual createItem(self, layout: QgsLayout | None) → QgsLayoutItem | None

Creates an instance of the corresponding item type.

Parameters:

layout (Optional[QgsLayout])

Return type:

Optional[QgsLayoutItem]

virtual createItemWidget(self, item: QgsLayoutItem | None) → QgsLayoutItemBaseWidget | None

Creates a configuration widget for an item of this type. Can return None if no configuration GUI is required.

Parameters:

item (Optional[QgsLayoutItem])

Return type:

Optional[QgsLayoutItemBaseWidget]

virtual createNodeRubberBand(self, view: QgsLayoutView | None) → QGraphicsItem | None

Creates a rubber band for use when creating layout node based items of this type. Can return None if no rubber band should be created. The default behavior is to return None.

See also

createRubberBand()

Parameters:

view (Optional[QgsLayoutView])

Return type:

Optional[QGraphicsItem]

virtual createRubberBand(self, view: QgsLayoutView | None) → QgsLayoutViewRubberBand | None

Creates a rubber band for use when creating layout items of this type. Can return None if no rubber band should be created. The default behavior is to create a rectangular rubber band.

See also

createNodeRubberBand()

Parameters:

view (Optional[QgsLayoutView])

Return type:

Optional[QgsLayoutViewRubberBand]

virtual creationIcon(self) → QIcon

Returns an icon representing creation of the layout item type.

Return type:

QIcon

flags(self) → QgsLayoutItemAbstractGuiMetadata.Flags

Returns item flags.

Return type:

QgsLayoutItemAbstractGuiMetadata.Flags

groupId(self) → str

Returns the item group ID, if set.

Return type:

str

virtual handleDoubleClick(self, item: QgsLayoutItem | None, action: Qgis.MouseHandlesAction)

Called when a layout item is double-clicked. The action parameter is used to specify which mouse handle, if any, was clicked If no mouse handle is selected, Qgis.MouseHandlesAction.NoAction is used

Added in version 3.42.

Parameters:

• item (Optional[QgsLayoutItem])

• action (Qgis.MouseHandlesAction)

isNodeBased(self) → bool

Returns True if the associated item is a node based item.

Return type:

bool

virtual newItemAddedToLayout(self, item: QgsLayoutItem | None)

Called when a newly created item of the associated type has been added to a layout.

This is only called for additions which result from GUI operations - i.e. it is not called for items added from templates.

Parameters:

item (Optional[QgsLayoutItem])

type(self) → int

Returns the unique item type code for the layout item class.

Return type:

int

visibleName(self) → str

Returns a translated, user visible name identifying the corresponding layout item.

Return type:

str