Subgroup: Layout

Class: QgsLayoutViewToolAddItem

class qgis.gui.QgsLayoutViewToolAddItem

Bases: qgis._gui.QgsLayoutViewTool

Layout view tool for adding items to a layout.

New in version 3.0: Methods

childEvent
connectNotify
customEvent
deactivate
disconnectNotify
isClickAndDrag
isSignalConnected
itemMetadataId Returns the item metadata id for items created by the tool.
layoutMoveEvent
layoutPressEvent
layoutReleaseEvent
receivers
sender
senderSignalIndex
setFlags
setItemMetadataId Sets the item metadata metadataId for items created by the tool.
timerEvent

Signals

createdItem Emitted when an item has been created using the tool.

Attributes

childEvent()
connectNotify()
createdItem

Emitted when an item has been created using the tool. [signal]

customEvent()
deactivate(self)
disconnectNotify()
isClickAndDrag()
isSignalConnected()
itemMetadataId(self) → int

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

layoutMoveEvent(self, event: QgsLayoutViewMouseEvent)
layoutPressEvent(self, event: QgsLayoutViewMouseEvent)
layoutReleaseEvent(self, event: QgsLayoutViewMouseEvent)
receivers()
sender()
senderSignalIndex()
setFlags()
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()

timerEvent()