Enum wayland_server::protocol::wl_shell_surface::Event

#[non_exhaustive]pub enum Event {
    Ping {
        serial: u32,
    },
    Configure {
        edges: Resize,
        width: i32,
        height: i32,
    },
    PopupDone,
}

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.

Ping

ping client

Ping a client to check if it is receiving events and sending requests. A client is expected to reply with a pong request.

Fields of Ping

serial: u32

Configure

suggest resize

The configure event asks the client to resize its surface.

The size is a hint, in the sense that the client is free to ignore it if it doesn't resize, pick a smaller size (to satisfy aspect ratio or resize in steps of NxM pixels).

The edges parameter provides a hint about how the surface was resized. The client may use this information to decide how to adjust its content to the new size (e.g. a scrolling area might adjust its content position to leave the viewable content unmoved).

The client is free to dismiss all but the last configure event it received.

The width and height arguments specify the size of the window in surface-local coordinates.

Fields of Configure

edges: Resizewidth: i32height: i32

PopupDone

popup interaction is done

The popup_done event is sent out when a popup grab is broken, that is, when the user clicks a surface that doesn't belong to the client owning the popup surface.

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.

impl MessageGroup for Event

pub const MESSAGES: &'static [MessageDesc]

Wire representation of this MessageGroup

type Map = ResourceMap

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

pub fn is_destructor(&self) -> bool

Whether this message is a destructor

pub fn opcode(&self) -> u16

The opcode of this message

pub fn since(&self) -> u32

The minimal object version for which this message exists

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

Retrieve the child Object associated with this message if any

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

Construct a message from its raw representation

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

Turn this message into its raw representation

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

Construct a message of this group from its C representation

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

Build a C representation of this message