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
action
Returns the action associated with the tool or None if no action is associated. activate
Called when tool is set as the currently active layout tool. blockSignals
childEvent
children
connectNotify
customEvent
deactivate
deleteLater
disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
event
eventFilter
findChild
findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject findChildren
findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] flags
Returns the current combination of flags set for the tool. ignoredSnapItems
Returns a list of items which should be ignored while snapping events for this tool. inherits
installEventFilter
isClickAndDrag
isSignalConnected
isWidgetType
isWindowType
itemMetadataId
Returns the item metadata id for items created by the tool. keyPressEvent
Key press event for overriding. keyReleaseEvent
Key release event for overriding. killTimer
layout
Returns the layout associated with the tool. layoutDoubleClickEvent
Mouse double-click event for overriding. layoutMoveEvent
layoutPressEvent
layoutReleaseEvent
metaObject
moveToThread
objectName
parent
property
pyqtConfigure
Each keyword argument is either the name of a Qt property or a Qt signal. receivers
removeEventFilter
sender
senderSignalIndex
setAction
Associates an action
with this tool.setCursor
Sets a user defined cursor
for use when the tool is active.setFlags
setItemMetadataId
Sets the item metadata metadataId
for items created by the tool.setObjectName
setParent
setProperty
signalsBlocked
startTimer
thread
timerEvent
toolName
Returns a user-visible, translated name for the tool. tr
view
Returns the view associated with the tool. wheelEvent
Mouse wheel event for overriding. Attributes
FlagSnaps
activated
Emitted when the tool is activated. createdItem
Emitted when an item has been created using the tool. deactivated
Emitted when the tool is deactivated. destroyed
destroyed(self, QObject = None) [signal] itemFocused
Emitted when an item
is “focused” by the tool, i.e.objectNameChanged
objectNameChanged(self, str) [signal] staticMetaObject
-
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
-
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 fromQgsLayoutItemGuiRegistry
.See also
-
timerEvent
()¶
-