ZxdgPositionerV6

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.

Members

Enums

Anchor enum Anchor: Undocumented in source.
ConstraintAdjustment enum ConstraintAdjustment: constraint adjustments
Error enum Error: Undocumented in source.
Gravity enum Gravity: Undocumented in source.

Functions

destroy void destroy(): destroy the xdg_positioner object
setAnchor void setAnchor(Anchor anchor): set anchor rectangle anchor edges
setAnchorRect void setAnchorRect(int x, int y, int width, int height): set the anchor rectangle within the parent surface
setConstraintAdjustment void setConstraintAdjustment(uint constraintAdjustment): set the adjustment to be done when constrained
setGravity void setGravity(Gravity gravity): set child surface gravity
setOffset void setOffset(int x, int y): set surface position offset
setSize void setSize(int width, int height): set the size of the to-be positioned rectangle

Manifest constants

destroyOpCode enum destroyOpCode;: Op-code of ZxdgPositionerV6.destroy.
destroySinceVersion enum destroySinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.destroy.
setAnchorOpCode enum setAnchorOpCode;: Op-code of ZxdgPositionerV6.setAnchor.
setAnchorRectOpCode enum setAnchorRectOpCode;: Op-code of ZxdgPositionerV6.setAnchorRect.
setAnchorRectSinceVersion enum setAnchorRectSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setAnchorRect.
setAnchorSinceVersion enum setAnchorSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setAnchor.
setConstraintAdjustmentOpCode enum setConstraintAdjustmentOpCode;: Op-code of ZxdgPositionerV6.setConstraintAdjustment.
setConstraintAdjustmentSinceVersion enum setConstraintAdjustmentSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setConstraintAdjustment.
setGravityOpCode enum setGravityOpCode;: Op-code of ZxdgPositionerV6.setGravity.
setGravitySinceVersion enum setGravitySinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setGravity.
setOffsetOpCode enum setOffsetOpCode;: Op-code of ZxdgPositionerV6.setOffset.
setOffsetSinceVersion enum setOffsetSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setOffset.
setSizeOpCode enum setSizeOpCode;: Op-code of ZxdgPositionerV6.setSize.
setSizeSinceVersion enum setSizeSinceVersion;: Version of xdg_shell_unstable_v6 protocol introducing ZxdgPositionerV6.setSize.
ver enum ver;: Version of xdg_shell_unstable_v6.zxdg_positioner_v6

Properties

iface immutable(WlProxyInterface) iface [@property getter]: Interface object that creates ZxdgPositionerV6 objects.