Enum wayland_protocols::xdg_shell::client::xdg_popup::Request

pub enum Request {
    Destroy,
    Grab {
        seat: Proxy<WlSeat>,
        serial: u32,
    },
}

Variants

Destroy

remove xdg_popup interface

This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface.

If this xdg_popup is not the “topmost” popup, a protocol error will be sent.

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

Grab

Fields

seat: Proxy<WlSeat>

serial: u32

make the popup take an explicit grab

This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.

If the compositor denies the grab, the popup will be immediately dismissed.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The serial number of the event should be passed as ‘serial’.

The parent of a grabbing popup must either be an xdg_toplevel surface or another xdg_popup with an explicit grab. If the parent is another xdg_popup it means that the popups are nested, with this popup now being the topmost popup.

Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one.

When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client.

The parent of a grabbing popup must either be another xdg_popup with an active explicit grab, or an xdg_popup or xdg_toplevel, if there are no explicit grabs already taken.

If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab.

If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised.

During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an “owner-events” grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.

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