Struct ZwpVirtualKeyboardV1

pub struct ZwpVirtualKeyboardV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

virtual keyboard

The virtual keyboard provides an application with requests which emulate the behaviour of a physical keyboard.

This interface can be used by clients on its own to provide raw input events, or it can accompany the input method protocol.

This interface has no events.

Implementations

impl ZwpVirtualKeyboardV1

pub fn keymap(&self, format: u32, fd: BorrowedFd<'_>, size: u32)

keyboard mapping

Provide a file descriptor to the compositor which can be memory-mapped to provide a keyboard mapping description.

Format carries a value from the keymap_format enumeration.

pub fn key(&self, time: u32, key: u32, state: u32)

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base. All requests regarding a single object must share the same clock.

Keymap must be set before issuing this request.

State carries a value from the key_state enumeration.

pub fn modifiers( &self, mods_depressed: u32, mods_latched: u32, mods_locked: u32, group: u32, )

modifier and group state

Notifies the compositor that the modifier and/or group state has changed, and it should update state.

The client should use wl_keyboard.modifiers event to synchronize its internal state with seat state.

Keymap must be set before issuing this request.

pub fn destroy(&self)

destroy the virtual keyboard keyboard object

Trait Implementations

impl Borrow<ObjectId> for ZwpVirtualKeyboardV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ZwpVirtualKeyboardV1

fn clone(&self) -> ZwpVirtualKeyboardV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZwpVirtualKeyboardV1

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

Formats the value using the given formatter.

impl Hash for ZwpVirtualKeyboardV1

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

fn eq(&self, other: &Weak<ZwpVirtualKeyboardV1>) -> 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 ZwpVirtualKeyboardV1

fn eq(&self, other: &ZwpVirtualKeyboardV1) -> 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 ZwpVirtualKeyboardV1

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

Send a request for this object.

fn send_constructor<I>( &self, req: <ZwpVirtualKeyboardV1 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<ZwpVirtualKeyboardV1, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> ZwpVirtualKeyboardV1

Create an inert object proxy

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

Parse a event for this object

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