Class: QgsLayoutViewToolAddItem¶
-
class
qgis.gui.
QgsLayoutViewToolAddItem
(view: QgsLayoutView)¶ Bases:
QgsLayoutViewTool
Constructs a
QgsLayoutViewToolAddItem
for the given layoutview
.Layout view tool for adding items to a layout.
New in version 3.0.
- Parameters
view –
-
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.
See also
- Return type
int
-
layoutMoveEvent
(self, event: QgsLayoutViewMouseEvent)¶ - Parameters
event (QgsLayoutViewMouseEvent) –
-
layoutPressEvent
(self, event: QgsLayoutViewMouseEvent)¶ - Parameters
event (QgsLayoutViewMouseEvent) –
-
layoutReleaseEvent
(self, event: QgsLayoutViewMouseEvent)¶ - Parameters
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 fromQgsLayoutItemGuiRegistry
.See also
- Parameters
metadataId (int) –
-
timerEvent
()¶