Enum wayland_protocols::xdg::shell::client::xdg_positioner::Request

#[non_exhaustive]
pub enum Request {
    Destroy,
    SetSize {
        width: i32,
        height: i32,
    },
    SetAnchorRect {
        x: i32,
        y: i32,
        width: i32,
        height: i32,
    },
    SetAnchor {
        anchor: WEnum<Anchor>,
    },
    SetGravity {
        gravity: WEnum<Gravity>,
    },
    SetConstraintAdjustment {
        constraint_adjustment: u32,
    },
    SetOffset {
        x: i32,
        y: i32,
    },
    SetReactive,
    SetParentSize {
        parent_width: i32,
        parent_height: i32,
    },
    SetParentConfigure {
        serial: u32,
    },
}

Available on crate feature client only.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Destroy

destroy the xdg_positioner object

Notify the compositor that the xdg_positioner will no longer be used.

This is a destructor, once sent this object cannot be used any longer.

SetSize

Fields

width: i32

width of positioned rectangle

height: i32

height of positioned rectangle

set the size of the to-be positioned rectangle

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If a zero or negative size is set the invalid_input error is raised.

SetAnchorRect

Fields

x: i32

x position of anchor rectangle

y: i32

y position of anchor rectangle

width: i32

width of anchor rectangle

height: i32

height of anchor rectangle

set the anchor rectangle within the parent surface

Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface.

When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child’s parent surface.

If a negative size is set the invalid_input error is raised.

SetAnchor

Fields

anchor: WEnum<Anchor>

anchor

set anchor rectangle anchor

Defines the anchor point for the anchor rectangle. The specified anchor is used derive an anchor point that the child surface will be positioned relative to. If a corner anchor is set (e.g. ‘top_left’ or ‘bottom_right’), the anchor point will be at the specified corner; otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

SetGravity

Fields

gravity: WEnum<Gravity>

gravity direction

set child surface gravity

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If a corner gravity is specified (e.g. ‘bottom_right’ or ‘top_left’), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified. If the gravity is not in the ‘gravity’ enum, an invalid_input error is raised.

SetConstraintAdjustment

Fields

constraint_adjustment: u32

bit mask of constraint adjustments

set the adjustment to be done when constrained

Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

SetOffset

Fields

x: i32

surface position x offset

y: i32

surface position y offset

set surface position offset

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

SetReactive

continuously reconstrain the surface

When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the parent window moved.

If the conditions changed and the popup was reconstrained, an xdg_popup.configure event is sent with updated geometry, followed by an xdg_surface.configure event.

Only available since version 3 of the interface

SetParentSize

Fields

parent_width: i32

future window geometry width of parent

parent_height: i32

future window geometry height of parent

Set the parent window geometry the compositor should use when positioning the popup. The compositor may use this information to determine the future state the popup should be constrained using. If this doesn’t match the dimension of the parent the popup is eventually positioned against, the behavior is undefined.

The arguments are given in the surface-local coordinate space.

Only available since version 3 of the interface

SetParentConfigure

Fields

serial: u32

serial of parent configure event

set parent configure this is a response to

Set the serial of an xdg_surface.configure event this positioner will be used in response to. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using.

Only available since version 3 of the interface

Implementations

impl Request

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.