Class: QgsLayoutViewToolAddNodeItem

Layout view tool for adding node based items to a layout.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsLayoutViewToolAddNodeItem

Base classes

QgsLayoutViewTool

Abstract base class for all layout view tools.

QObject

class qgis.gui.QgsLayoutViewToolAddNodeItem[source]

Bases: QgsLayoutViewTool

__init__(view: QgsLayoutView | None)

Constructs a QgsLayoutViewToolAddNodeItem for the given layout view.

Parameters:

view (Optional[QgsLayoutView])

signal createdItem[source]

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.

itemMetadataId(self) int[source]

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

Return type:

int

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)