Class: QgsLayoutViewToolAddItem¶

Layout view tool for adding items to a layout.

Class Hierarchy¶

Base classes¶

`QgsLayoutViewTool`	Abstract base class for all layout view tools. Layout view tools are user interactive tools for manipulating and adding items to `QgsLayoutView` widgets.
QObject

Methods

`customProperties`	Returns any custom properties set for the tool.
`itemMetadataId`	Returns the item metadata id for items created by the tool.
`setCustomProperties`	Sets custom properties for the tool.
`setItemMetadataId`	Sets the item metadata metadataId for items created by the tool.

Signals

createdItem

Emitted when an item has been created using the tool.

class qgis.gui.QgsLayoutViewToolAddItem[source]¶

Bases: QgsLayoutViewTool

__init__(view: QgsLayoutView | None)

Constructs a QgsLayoutViewToolAddItem for the given layout view.

Parameters:: view (Optional[QgsLayoutView])

signal createdItem[source]¶: Emitted when an item has been created using the tool.

customProperties(self) → Dict[str, Any][source]¶

Returns any custom properties set for the tool.

See also

setCustomProperties()

Added in version 3.18.

Return type:: Dict[str, Any]

itemMetadataId(self) → int[source]¶

Returns the item metadata id for items created by the tool.

See also

setItemMetadataId()

Return type:: int

setCustomProperties(self, properties: Dict[str, Any])[source]¶

Sets custom properties for the tool.

These properties are transient, and are cleared whenever the tool is activated. Callers must ensure that the properties are set only after the tool is activated.

See also

customProperties()

Added in version 3.18.

Parameters:: properties (Dict[str, Any])

setItemMetadataId(self, metadataId: int)[source]¶

Sets the item metadata metadataId for items created by the tool.

The metadataId associates the current tool behavior with a metadata entry from QgsLayoutItemGuiRegistry.

See also

itemMetadataId()

Parameters:: metadataId (int)