Class: QgsLayoutViewTool¶
- class qgis.gui.QgsLayoutViewTool(view: QgsLayoutView, name: str)¶
Bases:
PyQt5.QtCore.QObject
Constructor for
QgsLayoutViewTool
, taking a layoutview
and toolname
as parameters.Abstract base class for all layout view tools. Layout view tools are user interactive tools for manipulating and adding items to
QgsLayoutView
widgets.New in version 3.0:
Methods
Returns the action associated with the tool or
None
if no action is associated.Called when tool is set as the currently active layout tool.
Called when tool is deactivated.
Returns the current combination of flags set for the tool.
Returns a list of items which should be ignored while snapping events for this tool.
Returns
True
if a mouse press/release operation which started atstartViewPoint
and ended atendViewPoint
should be considered a "click and drag".Key press event for overriding.
Key release event for overriding.
Returns the layout associated with the tool.
Mouse double-click event for overriding.
Mouse move event for overriding.
Mouse press event for overriding.
Mouse release event for overriding.
Associates an
action
with this tool.Sets a user defined
cursor
for use when the tool is active.Sets the combination of
flags
that will be used for the tool.Returns a user-visible, translated name for the tool.
Returns the view associated with the tool.
Mouse wheel event for overriding.
Signals
Emitted when the tool is activated.
Emitted when the tool is deactivated.
Emitted when an
item
is "focused" by the tool, i.e. it should become the active item and should have its properties displayed in any designer windows.Attributes
- class Flag¶
Bases:
int
- FlagSnaps = 2¶
- class Flags¶
- class Flags(Union[QgsLayoutViewTool.Flags, QgsLayoutViewTool.Flag]) None
- class Flags(QgsLayoutViewTool.Flags) None
Bases:
sip.wrapper
- action(self) QAction ¶
Returns the action associated with the tool or
None
if no action is associated.See also
- Return type
QAction
- activate(self)¶
Called when tool is set as the currently active layout tool. Overridden implementations must take care to call the base class implementation.
- activated¶
Emitted when the tool is activated. [signal]
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- deactivate(self)¶
Called when tool is deactivated. Overridden implementations must take care to call the base class implementation.
- deactivated¶
Emitted when the tool is deactivated. [signal]
- disconnectNotify(self, QMetaMethod)¶
- flags(self) QgsLayoutViewTool.Flags ¶
Returns the current combination of flags set for the tool.
See also
- Return type
- ignoredSnapItems(self) List[QgsLayoutItem] ¶
Returns a list of items which should be ignored while snapping events for this tool.
- Return type
List[QgsLayoutItem]
- isClickAndDrag(self, startViewPoint: QPoint, endViewPoint: QPoint) bool ¶
Returns
True
if a mouse press/release operation which started atstartViewPoint
and ended atendViewPoint
should be considered a “click and drag”. IfFalse
is returned, the operation should be instead treated as just a click onstartViewPoint
.- Parameters
startViewPoint (QPoint) –
endViewPoint (QPoint) –
- Return type
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- itemFocused¶
Emitted when an
item
is “focused” by the tool, i.e. it should become the active item and should have its properties displayed in any designer windows. [signal]- Parameters
item (QgsLayoutItem) –
- keyPressEvent(self, event: QKeyEvent)¶
Key press event for overriding. Default implementation does nothing.
- Parameters
event (QKeyEvent) –
- keyReleaseEvent(self, event: QKeyEvent)¶
Key release event for overriding. Default implementation does nothing.
- Parameters
event (QKeyEvent) –
- layoutDoubleClickEvent(self, event: QgsLayoutViewMouseEvent)¶
Mouse double-click event for overriding. Default implementation does nothing.
- Parameters
event (QgsLayoutViewMouseEvent) –
- layoutMoveEvent(self, event: QgsLayoutViewMouseEvent)¶
Mouse move event for overriding. Default implementation does nothing.
- Parameters
event (QgsLayoutViewMouseEvent) –
- layoutPressEvent(self, event: QgsLayoutViewMouseEvent)¶
Mouse press event for overriding. Default implementation does nothing. Note that subclasses must ensure that they correctly handle cases when a layoutPressEvent is called without a corresponding layoutReleaseEvent (e.g. due to tool being changed mid way through a press-release operation).
- Parameters
event (QgsLayoutViewMouseEvent) –
- layoutReleaseEvent(self, event: QgsLayoutViewMouseEvent)¶
Mouse release event for overriding. Default implementation does nothing. Note that subclasses must ensure that they correctly handle cases when a layoutPressEvent is called without a corresponding layoutReleaseEvent (e.g. due to tool being changed mid way through a press-release operation).
- Parameters
event (QgsLayoutViewMouseEvent) –
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAction(self, action: QAction)¶
Associates an
action
with this tool. When the setLayoutTool method ofQgsLayoutView
is called the action’s state will be set to on. Usually this will cause a toolbutton to appear pressed in and the previously used toolbutton to pop out.See also
- Parameters
action (QAction) –
- setCursor(self, cursor: Union[QCursor, Qt.CursorShape])¶
Sets a user defined
cursor
for use when the tool is active.- Parameters
cursor (Union[QCursor) –
- setFlags(self, flags: Union[QgsLayoutViewTool.Flags, QgsLayoutViewTool.Flag])¶
Sets the combination of
flags
that will be used for the tool.See also
- Parameters
flags (Union[QgsLayoutViewTool.Flags) –
- timerEvent(self, QTimerEvent)¶
- toolName(self) str ¶
Returns a user-visible, translated name for the tool.
- Return type
str
- view(self) QgsLayoutView ¶
Returns the view associated with the tool.
See also
- Return type
- wheelEvent(self, event: QWheelEvent)¶
Mouse wheel event for overriding. Default implementation does nothing.
- Parameters
event (QWheelEvent) –