Class: QgsLayoutViewToolAddItem

class qgis.gui.QgsLayoutViewToolAddItem

Bases: QgsLayoutViewTool

Layout view tool for adding items to a layout.

QgsLayoutViewToolAddItem(view: Optional[QgsLayoutView]) Constructs a QgsLayoutViewToolAddItem for the given layout view.

Methods

activate

childEvent

connectNotify

customEvent

customProperties

Returns any custom properties set for the tool.

deactivate

disconnectNotify

isClickAndDrag

Returns True if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a "click and drag".

isSignalConnected

itemMetadataId

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

layoutMoveEvent

param event:

layoutPressEvent

param event:

layoutReleaseEvent

param event:

receivers

sender

senderSignalIndex

setCustomProperties

Sets custom properties for the tool.

setFlags

Sets the combination of flags that will be used for the tool.

setItemMetadataId

Sets the item metadata metadataId for items created by the tool.

timerEvent

Signals

createdItem

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

activate(self)
childEvent(self, a0: QChildEvent | None)
connectNotify(self, signal: QMetaMethod)
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.

Parameters:
  • name (str = ...)

  • revision (int = ...)

  • arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

customEvent(self, a0: QEvent | None)
customProperties(self) Dict[str, Any]

Returns any custom properties set for the tool.

Added in version 3.18.

Return type:

Dict[str, Any]

deactivate(self)
disconnectNotify(self, signal: QMetaMethod)
isClickAndDrag(self, startViewPoint: QPoint, endViewPoint: QPoint) bool

Returns True if a mouse press/release operation which started at startViewPoint and ended at endViewPoint should be considered a “click and drag”. If False is returned, the operation should be instead treated as just a click on startViewPoint.

isSignalConnected(self, signal: QMetaMethod) bool
itemMetadataId(self) int

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

Return type:

int

layoutMoveEvent(self, event: QgsLayoutViewMouseEvent | None)
Parameters:

event (Optional[QgsLayoutViewMouseEvent])

layoutPressEvent(self, event: QgsLayoutViewMouseEvent | None)
Parameters:

event (Optional[QgsLayoutViewMouseEvent])

layoutReleaseEvent(self, event: QgsLayoutViewMouseEvent | None)
Parameters:

event (Optional[QgsLayoutViewMouseEvent])

receivers(self, signal: PYQT_SIGNAL) int
sender(self) QObject | None
senderSignalIndex(self) 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.

Added in version 3.18.

Parameters:

properties (Dict[str)

setFlags(self, flags: QgsLayoutViewTool.Flags | QgsLayoutViewTool.Flag)

Sets the combination of flags that will be used for the tool.

See also

flags()

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)

timerEvent(self, a0: QTimerEvent | None)