Class: QgsFloatingWidget¶
- class qgis.gui.QgsFloatingWidget(parent: QWidget = None)¶
Bases:
PyQt5.QtWidgets.QWidget
Constructor for QgsFloatingWidget.
- Parameters
parent – parent widget
A QWidget subclass for creating widgets which float outside of the normal Qt layout system. Floating widgets use an “anchor widget” to determine how they are anchored within their parent widget.
Methods
Returns the floating widget’s anchor point, which corresponds to the point on the widget which should remain fixed in the same relative position whenever the widget’s parent is resized or moved.
Returns the widget that the floating widget is “anchored” tto.
Returns the anchor widget’s anchor point, which corresponds to the point on the anchor widget which the floating widget should “attach” to.
- param e
- param e
Sets the floating widget’s anchor point, which corresponds to the point on the widget which should remain fixed in the same relative position whenever the widget’s parent is resized or moved.
Sets the widget to “anchor” the floating widget to.
Returns the anchor widget’s anchor point, which corresponds to the point on the anchor widget which the floating widget should “attach” to.
- param e
Signals
Emitted when the anchor point changes [signal]
Emitted when the anchor widget changes [signal]
Emitted when the anchor widget point changes [signal]
Attributes
- class AnchorPoint¶
Bases:
int
- baseClass¶
alias of
qgis._gui.QgsFloatingWidget
- BottomLeft = 6¶
- BottomMiddle = 7¶
- BottomRight = 8¶
- Middle = 4¶
- MiddleLeft = 3¶
- MiddleRight = 5¶
- TopLeft = 0¶
- TopMiddle = 1¶
- TopRight = 2¶
- actionEvent(self, QActionEvent)¶
- anchorPoint(self) → QgsFloatingWidget.AnchorPoint¶
Returns the floating widget’s anchor point, which corresponds to the point on the widget which should remain fixed in the same relative position whenever the widget’s parent is resized or moved.
See also
- Return type
- anchorPointChanged¶
Emitted when the anchor point changes [signal]
- Parameters
point (QgsFloatingWidget.AnchorPoint) –
- anchorWidget(self) → QWidget¶
Returns the widget that the floating widget is “anchored” tto. The floating widget will be repositioned whenever the anchor widget moves or is resized so that it maintains the same relative position to the anchor widget.
See also
- Return type
QWidget
- anchorWidgetChanged¶
Emitted when the anchor widget changes [signal]
- Parameters
widget (QWidget) –
- anchorWidgetPoint(self) → QgsFloatingWidget.AnchorPoint¶
Returns the anchor widget’s anchor point, which corresponds to the point on the anchor widget which the floating widget should “attach” to. The floating widget should remain fixed in the same relative position to this anchor widget whenever the widget’s parent is resized or moved.
See also
- Return type
- anchorWidgetPointChanged¶
Emitted when the anchor widget point changes [signal]
- Parameters
point (QgsFloatingWidget.AnchorPoint) –
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- 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¶
- 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¶
- keyPressEvent(self, QKeyEvent)¶
- 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, e: QPaintEvent)¶
- Parameters
e (QPaintEvent) –
- receivers(self, PYQT_SIGNAL) → int¶
- resizeEvent(self, e: QResizeEvent)¶
- Parameters
e (QResizeEvent) –
- sender(self) → QObject¶
- senderSignalIndex(self) → int¶
- setAnchorPoint(self, point: QgsFloatingWidget.AnchorPoint)¶
Sets the floating widget’s anchor point, which corresponds to the point on the widget which should remain fixed in the same relative position whenever the widget’s parent is resized or moved.
- Parameters
point (QgsFloatingWidget.AnchorPoint) – anchor point
See also
- setAnchorWidget(self, widget: QWidget)¶
Sets the widget to “anchor” the floating widget to. The floating widget will be repositioned whenever the anchor widget moves or is resized so that it maintains the same relative position to the anchor widget.
- Parameters
widget (QWidget) – anchor widget. Both the floating widget and the anchor widget must share some common parent.
See also
- setAnchorWidgetPoint(self, point: QgsFloatingWidget.AnchorPoint)¶
Returns the anchor widget’s anchor point, which corresponds to the point on the anchor widget which the floating widget should “attach” to. The floating widget should remain fixed in the same relative position to this anchor widget whenever the widget’s parent is resized or moved.
See also
- Parameters
point (QgsFloatingWidget.AnchorPoint) –
- showEvent(self, e: QShowEvent)¶
- Parameters
e (QShowEvent) –
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶