Struct wayland_protocols::xwayland::keyboard_grab::zv1::client::zwp_xwayland_keyboard_grab_manager_v1::ZwpXwaylandKeyboardGrabManagerV1

pub struct ZwpXwaylandKeyboardGrabManagerV1 {
    id: ObjectId,
    version: u32,
    data: Option<Arc<dyn ObjectData>>,
    backend: WeakBackend,
}

context object for keyboard grab manager

A global interface used for grabbing the keyboard.

This interface has no events.

Fields

id: ObjectId

version: u32

data: Option<Arc<dyn ObjectData>>

backend: WeakBackend

Implementations

impl ZwpXwaylandKeyboardGrabManagerV1

pub fn destroy(&self)

destroy the keyboard grab manager

Destroy the keyboard grab manager.

pub fn grab_keyboard<U: Send + Sync + 'static, D: Dispatch<ZwpXwaylandKeyboardGrabV1, U> + 'static>( &self, surface: &WlSurface, seat: &WlSeat, qh: &QueueHandle<D>, udata: U, ) -> ZwpXwaylandKeyboardGrabV1

grab the keyboard to a surface

The grab_keyboard request asks for a grab of the keyboard, forcing the keyboard focus for the given seat upon the given surface.

The protocol provides no guarantee that the grab is ever satisfied, and does not require the compositor to send an error if the grab cannot ever be satisfied. It is thus possible to request a keyboard grab that will never be effective.

The protocol:

• does not guarantee that the grab itself is applied for a surface, the grab request may be silently ignored by the compositor,
• does not guarantee that any events are sent to this client even if the grab is applied to a surface,
• does not guarantee that events sent to this client are exhaustive, a compositor may filter some events for its own consumption,
• does not guarantee that events sent to this client are continuous, a compositor may change and reroute keyboard events while the grab is nominally active.

Trait Implementations

impl Borrow<ObjectId> for ZwpXwaylandKeyboardGrabManagerV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpXwaylandKeyboardGrabManagerV1

fn clone(&self) -> ZwpXwaylandKeyboardGrabManagerV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpXwaylandKeyboardGrabManagerV1

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

Formats the value using the given formatter.

impl Hash for ZwpXwaylandKeyboardGrabManagerV1

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ZwpXwaylandKeyboardGrabManagerV1>> for ZwpXwaylandKeyboardGrabManagerV1

fn eq(&self, other: &Weak<ZwpXwaylandKeyboardGrabManagerV1>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ZwpXwaylandKeyboardGrabManagerV1

fn eq(&self, other: &ZwpXwaylandKeyboardGrabManagerV1) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for ZwpXwaylandKeyboardGrabManagerV1

type Request<'request> = Request<'request>

The request enum for this interface

type Event = Event

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

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

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ZwpXwaylandKeyboardGrabManagerV1