Class: QgsLayoutViewToolAddItem

Layout view tool for adding items to a layout.

Class Hierarchy

Base classes

QgsLayoutViewTool	Abstract base class for all layout view tools.
QObject

class qgis.gui.QgsLayoutViewToolAddItem

Bases: QgsLayoutViewTool

__init__(view: QgsLayoutView | None)

Constructs a QgsLayoutViewToolAddItem for the given layout view.

Parameters:

view (Optional[QgsLayoutView])

signal createdItem

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

customProperties(self) → Dict[str, Any]

Returns any custom properties set for the tool.

See also

setCustomProperties()

Added in version 3.18.

Return type:

Dict[str, Any]

itemMetadataId(self) → int

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

See also

setItemMetadataId()

Return type:

int

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

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)

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)