Class: QgsLayoutItemGuiRegistry

Registry of available layout item GUI behavior.

QgsLayoutItemGuiRegistry is not usually directly created, but rather accessed through QgsGui.layoutItemGuiRegistry().

This acts as a companion to QgsLayoutItemRegistry, handling only the components related to the GUI behavior of layout items.

Class Hierarchy

Base classes

QObject

Methods

addItemGroup	Registers a new item group with the registry.
addLayoutItemGuiMetadata	Registers the GUI metadata for a new layout item type.
createItem	Creates a new instance of a layout item given the item metadata metadataId, target layout.
createItemWidget	Creates a new instance of a layout item configuration widget for the specified item.
itemGroup	Returns a reference to the item group with matching id.
itemMetadata	Returns the metadata for the specified item metadataId.
itemMetadataIds	Returns a list of available item metadata ids handled by the registry.
metadataIdForItemType	Returns the GUI item metadata ID which corresponds to the specified layout item type.
newItemAddedToLayout	Called when a newly created item of the associated metadata metadataId has been added to a layout.
removeItemGroup	Unregisters an item group from the registry.
removeLayoutItemGuiMetadata	Unregisters the GUI metadata for a layout item type.

Signals

groupRemoved	Emitted whenever an item group is removed from the registry.
typeAdded	Emitted whenever a new item type is added to the registry, with the specified metadataId.
typeRemoved	Emitted whenever an item type is removed from the registry, with the specified metadataId.

class qgis.gui.QgsLayoutItemGuiRegistry

Bases: QObject

__init__(parent: QObject | None = None)

Creates a new empty item GUI registry.

QgsLayoutItemGuiRegistry is not usually directly created, but rather accessed through QgsGui.layoutItemGuiRegistry().

Parameters:

parent (Optional[QObject] = None)

addItemGroup(self, group: QgsLayoutItemGuiGroup) → bool

Registers a new item group with the registry. This must be done before calling addLayoutItemGuiMetadata() for any item types associated with the group.

Returns True if group was added, or False if group could not be added (e.g. due to duplicate id value).

See also

itemGroup()

Parameters:

group (QgsLayoutItemGuiGroup)

Return type:

bool

addLayoutItemGuiMetadata(self, metadata: QgsLayoutItemAbstractGuiMetadata | None) → bool

Registers the GUI metadata for a new layout item type. Takes ownership of the metadata instance.

Parameters:

metadata (Optional[QgsLayoutItemAbstractGuiMetadata])

Return type:

bool

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

Creates a new instance of a layout item given the item metadata metadataId, target layout.

Parameters:

• metadataId (int)

• layout (Optional[QgsLayout])

Return type:

Optional[QgsLayoutItem]

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

Creates a new instance of a layout item configuration widget for the specified item.

Parameters:

item (Optional[QgsLayoutItem])

Return type:

Optional[QgsLayoutItemBaseWidget]

signal groupRemoved(groupId: str)

Emitted whenever an item group is removed from the registry.

Added in version 4.0.

Parameters:

groupId (str)

itemGroup(self, id: str | None) → QgsLayoutItemGuiGroup

Returns a reference to the item group with matching id.

See also

addItemGroup()

Parameters:

id (Optional[str])

Return type:

QgsLayoutItemGuiGroup

itemMetadata(self, metadataId: int) → QgsLayoutItemAbstractGuiMetadata | None

Returns the metadata for the specified item metadataId. Returns None if a corresponding metadataId was not found in the registry.

Parameters:

metadataId (int)

Return type:

Optional[QgsLayoutItemAbstractGuiMetadata]

itemMetadataIds(self) → List[int]

Returns a list of available item metadata ids handled by the registry.

Return type:

List[int]

metadataIdForItemType(self, type: int) → int

Returns the GUI item metadata ID which corresponds to the specified layout item type.

In the case that multiple GUI metadata classes exist for a single layout item type then only the first encountered GUI metadata ID will be returned.

Returns -1 if no matching metadata is found in the GUI registry.

Added in version 3.18.

Parameters:

type (int)

Return type:

int

newItemAddedToLayout(self, metadataId: int, item: QgsLayoutItem | None, properties: Dict[str, Any] = {})

Called when a newly created item of the associated metadata metadataId 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.

Since QGIS 3.18 the optional properties argument can be used to pass custom properties to the QgsLayoutItemGuiMetadata.newItemAddedToLayout() function.

Parameters:

• metadataId (int)

• item (Optional[QgsLayoutItem])

• properties (Dict[str, Any] = {})

removeItemGroup(self, id: str | None) → bool

Unregisters an item group from the registry.

This must be done after calling removeLayoutItemGuiMetadata() for every item types associated with the group.

Added in version 4.0.

Parameters:

id (Optional[str])

Return type:

bool

removeLayoutItemGuiMetadata(self, type: int) → bool

Unregisters the GUI metadata for a layout item type.

Added in version 4.0.

Parameters:

type (int)

Return type:

bool

removeLayoutItemGuiMetadata(self, metadata: QgsLayoutItemAbstractGuiMetadata | None) → bool

Unregisters the GUI metadata for a layout item type.

The metadata object will be deleted and should not be used after this call.

Added in version 4.0.

Parameters:

metadata (Optional[QgsLayoutItemAbstractGuiMetadata])

Return type:

bool

signal typeAdded(metadataId: int)

Emitted whenever a new item type is added to the registry, with the specified metadataId.

Parameters:

metadataId (int)

signal typeRemoved(metadataId: int)

Emitted whenever an item type is removed from the registry, with the specified metadataId.

Added in version 4.0.

Parameters:

metadataId (int)