Class: QgsAnnotationItemBaseWidget¶
- class qgis.gui.QgsAnnotationItemBaseWidget¶
Bases:
QgsPanelWidget
A base class for property widgets for annotation items.
All annotation item widgets should inherit from this base class.
New in version 3.22.
QgsAnnotationItemBaseWidget(parent: QWidget) Constructor for QgsAnnotationItemBaseWidget.
Methods
Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
Creates a new item matching the settings defined in the widget.
Focuses the default widget for the page.
Overridden key press event to handle the esc event on the widget.
Sets the
context
in which the widget is shown, e.g., the associated map canvas and expression contexts.Sets the current
item
to show in the widget.Attempts to update the widget to show the properties for the specified
item
.Updates an existing item to match the settings defined in the widget.
Signals
Emitted when the annotation item definition in the widget is changed by the user.
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- context(self) QgsSymbolWidgetContext ¶
Returns the context in which the widget is shown, e.g., the associated map canvas and expression contexts.
See also
- Return type
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- createItem(self) QgsAnnotationItem ¶
Creates a new item matching the settings defined in the widget.
- Return type
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- focusDefaultWidget(self)¶
Focuses the default widget for the page.
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- itemChanged¶
Emitted when the annotation item definition in the widget is changed by the user. [signal]
- keyPressEvent(self, event: QKeyEvent)¶
Overridden key press event to handle the esc event on the widget.
- Parameters
event – The key event
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setContext(self, context: QgsSymbolWidgetContext)¶
Sets the
context
in which the widget is shown, e.g., the associated map canvas and expression contexts.See also
- Parameters
context (QgsSymbolWidgetContext) –
- setItem(self, item: QgsAnnotationItem) bool ¶
Sets the current
item
to show in the widget. IfTrue
is returned,item
was an acceptable type for display in this widget and the widget has been updated to matchitem
’s properties.If
False
is returned, then the widget could not be successfully updated to show the properties ofitem
.- Parameters
item (QgsAnnotationItem) –
- Return type
bool
- setNewItem(self, item: QgsAnnotationItem) bool ¶
Attempts to update the widget to show the properties for the specified
item
.Subclasses can override this if they support changing items in place.
Implementations must return
True
if the item was accepted and the widget was updated.- Parameters
item (QgsAnnotationItem) –
- Return type
bool
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateItem(self, item: QgsAnnotationItem)¶
Updates an existing item to match the settings defined in the widget.
- Parameters
item (QgsAnnotationItem) –
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶