Struct WlKeyboard

pub struct WlKeyboard { /* private fields */ }

Available on crate feature wayland and Linux only.

keyboard input device

The wl_keyboard interface represents one or more keyboards associated with a seat.

Each wl_keyboard has the following logical state:

• an active surface (possibly null),
• the keys currently logically down,
• the active modifiers,
• the active group.

By default, the active surface is null, the keys currently logically down are empty, the active modifiers and the active group are 0.

See also the Event enum for this interface.

Implementations

impl WlKeyboard

pub fn release(&self)

release the keyboard object

Trait Implementations

impl Borrow<ObjectId> for WlKeyboard

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for WlKeyboard

fn clone(&self) -> WlKeyboard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WlKeyboard

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

Formats the value using the given formatter.

impl<D, U> Dispatch<WlKeyboard, U, D> for SeatState

where D: Dispatch<WlKeyboard, U> + KeyboardHandler, U: KeyboardDataExt,

fn event( data: &mut D, keyboard: &WlKeyboard, event: Event, udata: &U, conn: &Connection, qh: &QueueHandle<D>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, _qhandle: &QueueHandle<State>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Hash for WlKeyboard

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

where H: Hasher,

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<WlKeyboard>> for WlKeyboard

fn eq(&self, other: &Weak<WlKeyboard>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for WlKeyboard

fn eq(&self, other: &WlKeyboard) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Proxy for WlKeyboard

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>(&self) -> Option<&U>

where U: Send + Sync + 'static,

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: <WlKeyboard as Proxy>::Request<'_>, ) -> Result<(), InvalidId>

Send a request for this object.

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

where I: Proxy,

Send a request for this object that creates another object.

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

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> WlKeyboard

Create an inert object proxy

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

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: <WlKeyboard as Proxy>::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 WlKeyboard