PopupAnchor - Quickshell

PopupAnchor: QtObject

uncreatable

import Quickshell

Anchorpoint or positioner for popup windows.

adjustment : PopupAdjustment

The strategy used to adjust the popup’s position if it would otherwise not fit on screen, based on the anchor rect, preferred edges, and gravity.

See the documentation for PopupAdjustment for details.
edges : Edges

The point on the anchor rectangle the popup should anchor to. Opposing edges suchs as Edges.Left | Edges.Right are not allowed.

Defaults to Edges.Top | Edges.Left.
gravity : Edges

The direction the popup should expand towards, relative to the anchorpoint. Opposing edges suchs as Edges.Left | Edges.Right are not allowed.

Defaults to Edges.Bottom | Edges.Right.
item : Item

The item to anchor / attach the popup to. Setting this property unsets window.

The popup’s position relative to its parent window is only calculated when it is initially shown (directly before anchoring() is emitted), meaning its anchor rectangle will be set relative to the item’s position in the window at that time. updateAnchor() can be called to update the anchor rectangle if the item’s position has changed.

NOTE

If a more flexible way to position a popup relative to an item is needed, set window to the item’s parent window, and handle the anchoring signal to position the popup relative to the window’s contentItem.
margins : [left,right,top,bottom]

left:int right:int top:int bottom:int

A margin applied to the anchor rect.

This is most useful when item is used and rect is left at its default value (matching the Item’s dimensions).
rect : [h,y,x,w,width,height]

h:int y:int x:int w:int width:int height:int

The anchorpoints the popup will attach to, relative to item or window. Which anchors will be used is determined by the edges, gravity, and adjustment.

If using item, the default anchor rectangle matches the dimensions of the item.

If you leave edges, gravity and adjustment at their default values, setting more than x and y does not matter. The anchor rect cannot be smaller than 1x1 pixels.
window : QtObject

The window to anchor / attach the popup to. Setting this property unsets item.

updateAnchor() : void

Update the popup’s anchor rect relative to its parent window.

If anchored to an item, popups anchors will not automatically follow the item if its position changes. This function can be called to recalculate the anchors.

anchoring() ?

Emitted when this anchor is about to be used. Mostly useful for modifying the anchor rect using coordinate mapping functions, which are not reactive.