Module wayland_protocols::xdg_shell::client::xdg_positioner

child surface positioner

The xdg_positioner provides a collection of rules for the placement of a child surface relative to a parent surface. Rules can be defined to ensure the child surface remains within the visible area's borders, and to specify how the child surface changes its position, such as sliding along an axis, or flipping around a rectangle. These positioner-created rules are constrained by the requirement that a child surface must intersect with or be at least partially adjacent to its parent surface.

See the various requests for details about possible rules.

At the time of the request, the compositor makes a copy of the rules specified by the xdg_positioner. Thus, after the request is complete the xdg_positioner object can be destroyed or reused; further changes to the object will have no effect on previous usages.

For an xdg_positioner object to be considered complete, it must have a non-zero size set by set_size, and a non-zero anchor rectangle set by set_anchor_rect. Passing an incomplete xdg_positioner object when positioning a surface raises an error.

Structs

ConstraintAdjustment	constraint adjustments
XdgPositioner

Enums

Anchor
Error
Event
Gravity
Request

Constants

REQ_DESTROY_SINCE	The minimal object version supporting this request
REQ_SET_ANCHOR_RECT_SINCE	The minimal object version supporting this request
REQ_SET_ANCHOR_SINCE	The minimal object version supporting this request
REQ_SET_CONSTRAINT_ADJUSTMENT_SINCE	The minimal object version supporting this request
REQ_SET_GRAVITY_SINCE	The minimal object version supporting this request
REQ_SET_OFFSET_SINCE	The minimal object version supporting this request
REQ_SET_PARENT_CONFIGURE_SINCE	The minimal object version supporting this request
REQ_SET_PARENT_SIZE_SINCE	The minimal object version supporting this request
REQ_SET_REACTIVE_SINCE	The minimal object version supporting this request
REQ_SET_SIZE_SINCE	The minimal object version supporting this request

Statics

xdg_positioner_interface	C representation of this interface, for interop
xdg_positioner_requests	C-representation of the messages of this interface, for interop