Class: QgsFloatingWidget

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.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsFloatingWidget

Base classes

QWidget

QObject

QPaintDevice

Subclasses

QgsUserInputWidget

A floating widget that can be used to display widgets for user inputs.

Methods

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.

anchorWidget

Returns the widget that the floating widget is "anchored" tto.

anchorWidgetPoint

Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which the floating widget should "attach" to.

setAnchorPoint

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.

setAnchorWidget

Sets the widget to "anchor" the floating widget to.

setAnchorWidgetPoint

Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which the floating widget should "attach" to.

Signals

anchorPointChanged

Emitted when the anchor point changes

anchorWidgetChanged

Emitted when the anchor widget changes

anchorWidgetPointChanged

Emitted when the anchor widget point changes

Attributes

BottomLeft

BottomMiddle

BottomRight

Middle

MiddleLeft

MiddleRight

TopLeft

TopMiddle

TopRight

class qgis.gui.QgsFloatingWidget[source]

Bases: QWidget

__init__(parent: QWidget | None = None)

Constructor for QgsFloatingWidget.

Parameters:

parent (Optional[QWidget] = None) – parent widget

class AnchorPoint

Bases: int

BottomLeft = 6
BottomMiddle = 7
BottomRight = 8
Middle = 4
MiddleLeft = 3
MiddleRight = 5
TopLeft = 0
TopMiddle = 1
TopRight = 2
anchorPoint(self) QgsFloatingWidget.AnchorPoint[source]

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

setAnchorPoint()

Return type:

QgsFloatingWidget.AnchorPoint

signal anchorPointChanged(point: QgsFloatingWidget.AnchorPoint)[source]

Emitted when the anchor point changes

Parameters:

point (QgsFloatingWidget.AnchorPoint)

anchorWidget(self) QWidget | None[source]

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.

Return type:

Optional[QWidget]

signal anchorWidgetChanged(widget: QWidget)[source]

Emitted when the anchor widget changes

Parameters:

widget (QWidget)

anchorWidgetPoint(self) QgsFloatingWidget.AnchorPoint[source]

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.

Return type:

QgsFloatingWidget.AnchorPoint

signal anchorWidgetPointChanged(point: QgsFloatingWidget.AnchorPoint)[source]

Emitted when the anchor widget point changes

Parameters:

point (QgsFloatingWidget.AnchorPoint)

setAnchorPoint(self, point: QgsFloatingWidget.AnchorPoint)[source]

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

anchorPoint()

setAnchorWidget(self, widget: QWidget | None)[source]

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 (Optional[QWidget]) – anchor widget. Both the floating widget and the anchor widget must share some common parent.

See also

anchorWidget()

setAnchorWidgetPoint(self, point: QgsFloatingWidget.AnchorPoint)[source]

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.

Parameters:

point (QgsFloatingWidget.AnchorPoint)