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

Base classes

QWidget
QObject
QPaintDevice

Subclasses

QgsUserInputWidget

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

class qgis.gui.QgsFloatingWidget

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

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

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.

anchorWidget(self) → QWidget | None

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

setAnchorWidget()

Return type:

Optional[QWidget]

signal anchorWidgetChanged

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.

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

setAnchorWidgetPoint()

Return type:

QgsFloatingWidget.AnchorPoint

signal anchorWidgetPointChanged

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.

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

anchorPoint()

setAnchorWidget(self, widget: QWidget | None)

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)

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

setAnchorWidgetPoint()

Parameters:

point (QgsFloatingWidget.AnchorPoint)