Enum wayland_protocols::unstable::xdg_shell::v5::client::xdg_shell::Request

pub enum Request {
    Destroy,
    UseUnstableVersion {
        version: i32,
    },
    GetXdgSurface {
        id: Proxy<XdgSurface>,
        surface: Proxy<WlSurface>,
    },
    GetXdgPopup {
        id: Proxy<XdgPopup>,
        surface: Proxy<WlSurface>,
        parent: Proxy<WlSurface>,
        seat: Proxy<WlSeat>,
        serial: u32,
        x: i32,
        y: i32,
    },
    Pong {
        serial: u32,
    },
}

Variants

Destroy

destroy xdg_shell

Destroy this xdg_shell object.

Destroying a bound xdg_shell object while there are surfaces still alive created by this xdg_shell object instance is illegal and will result in a protocol error.

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

UseUnstableVersion

Fields

version: i32

enable use of this unstable version

Negotiate the unstable version of the interface. This mechanism is in place to ensure client and server agree on the unstable versions of the protocol that they speak or exit cleanly if they don’t agree. This request will go away once the xdg-shell protocol is stable.

GetXdgSurface

Fields

id: Proxy<XdgSurface>

surface: Proxy<WlSurface>

create a shell surface from a surface

This creates an xdg_surface for the given surface and gives it the xdg_surface role. A wl_surface can only be given an xdg_surface role once. If get_xdg_surface is called with a wl_surface that already has an active xdg_surface associated with it, or if it had any other role, an error is raised.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

GetXdgPopup

Fields

id: Proxy<XdgPopup>

surface: Proxy<WlSurface>

parent: Proxy<WlSurface>

seat: Proxy<WlSeat>

serial: u32

x: i32

y: i32

create a popup for a surface

This creates an xdg_popup for the given surface and gives it the xdg_popup role. A wl_surface can only be given an xdg_popup role once. If get_xdg_popup is called with a wl_surface that already has an active xdg_popup associated with it, or if it had any other role, an error is raised.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

Pong

Fields

serial: u32

respond to a ping event

A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

Trait Implementations

impl MessageGroup for Request

const MESSAGES: &'static [MessageDesc] = _

Wire representation of this MessageGroup

type Map = ProxyMap

The wrapper type for ObjectMap allowing the mapping of Object and NewId arguments to the object map during parsing.

fn is_destructor(&self) -> bool

Whether this message is a destructor

fn opcode(&self) -> u16

The opcode of this message

fn child<Meta: ObjectMetadata>(
    opcode: u16,
    version: u32,
    meta: &Meta
) -> Option<Object<Meta>>

Retrieve the child Object associated with this message if any

fn from_raw(msg: Message, map: &mut Self::Map) -> Result<Self, ()>

Construct a message from its raw representation

fn into_raw(self, sender_id: u32) -> Message

Turn this message into its raw representation

unsafe fn from_raw_c(
    obj: *mut c_void,
    opcode: u32,
    args: *const wl_argument
) -> Result<Request, ()>

Construct a message of this group from its C representation

fn as_raw_c_in<F, T>(self, f: F) -> Twhere
    F: FnOnce(u32, &mut [wl_argument]) -> T,

Build a C representation of this message