Class: QgsFloatingWidget

class qgis.gui.QgsFloatingWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsFloatingWidget.

Parameters

parent (QWidget = None) – 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

actionEvent

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.

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

initPainter

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

param e

receivers

resizeEvent

param e

sender

senderSignalIndex

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.

sharedPainter

showEvent

param e

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

anchorPointChanged

Emitted when the anchor point changes [signal]

anchorWidgetChanged

Emitted when the anchor widget changes [signal]

anchorWidgetPointChanged

Emitted when the anchor widget point changes [signal]

Attributes

BottomLeft

BottomMiddle

BottomRight

Middle

MiddleLeft

MiddleRight

TopLeft

TopMiddle

TopRight

class AnchorPoint

Bases: int

baseClass

alias of QgsFloatingWidget

BottomLeft = 6
BottomMiddle = 7
BottomRight = 8
Middle = 4
MiddleLeft = 3
MiddleRight = 5
TopLeft = 0
TopMiddle = 1
TopRight = 2
actionEvent()
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

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.

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.

Return type

QgsFloatingWidget.AnchorPoint

anchorWidgetPointChanged

Emitted when the anchor widget point changes [signal]

Parameters

point (QgsFloatingWidget.AnchorPoint) –

changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent(self, e: QPaintEvent)
Parameters

e (QPaintEvent) –

receivers()
resizeEvent(self, e: QResizeEvent)
Parameters

e (QResizeEvent) –

sender()
senderSignalIndex()
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)

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

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.

Parameters

point (QgsFloatingWidget.AnchorPoint) –

sharedPainter()
showEvent(self, e: QShowEvent)
Parameters

e (QShowEvent) –

tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()