Struct xdg_shell_server_protocol::xdg_positioner::XdgPositioner

pub struct XdgPositioner;

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.

Trait Implementations

impl Debug for XdgPositioner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Interface for XdgPositioner

const NAME: &'static str = "xdg_positioner"

The name of this interface. This will correspond to the ‘name’ attribute on the ‘interface’ element in the wayland protocol XML.

const VERSION: u32 = 3u32

The version of this interface. This will correspond to the ‘version’ attribute on the ‘interface’ element in the wayland protocol XML.

const REQUESTS: MessageGroupSpec = _

A description of the structure of request messages.

const EVENTS: MessageGroupSpec = _

A description of the structure of event messages.

type Incoming = Request

The rust type that can hold the decoded incoming messages.

type Outgoing = Event

The rust type that can be decoded into outgoing messages.