Struct wayland_protocols::xdg::shell::server::xdg_positioner::XdgPositioner

pub struct XdgPositioner { /* private fields */ }

Available on crate feature server only.

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.

See also the Request enum for this interface.

Trait Implementations

impl Clone for XdgPositioner

fn clone(&self) -> XdgPositioner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for XdgPositioner

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

Formats the value using the given formatter.

impl PartialEq<XdgPositioner> for XdgPositioner

fn eq(&self, other: &XdgPositioner) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Resource for XdgPositioner

type Request = Request

type Event = Event

fn interface() -> &'static Interface

fn id(&self) -> ObjectId

fn version(&self) -> u32

fn data<U: 'static>(&self) -> Option<&U>

fn object_data(&self) -> Option<&Arc<dyn Any + Send + Sync>>

fn handle(&self) -> &WeakHandle

fn from_id(conn: &DisplayHandle, id: ObjectId) -> Result<Self, InvalidId>

fn send_event(&self, evt: Self::Event) -> Result<(), InvalidId>

fn parse_request(
    conn: &DisplayHandle,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Request), DispatchError>

fn write_event(
    &self,
    conn: &DisplayHandle,
    msg: Self::Event
) -> Result<Message<ObjectId>, InvalidId>

fn post_error(
    &self,
    dh: &DisplayHandle,
    code: impl Into<u32>,
    error: impl Into<String>
)

impl Eq for XdgPositioner