Struct wayland_server::protocol::wl_keyboard::WlKeyboard

pub struct WlKeyboard(_);

Implementations

impl WlKeyboard

pub fn keymap(&self, format: KeymapFormat, fd: RawFd, size: u32)

keyboard mapping

This event provides a file descriptor to the client which can be memory-mapped in read-only mode to provide a keyboard mapping description.

From version 7 onwards, the fd must be mapped with MAP_PRIVATE by the recipient, as MAP_SHARED may fail.

pub fn enter(&self, serial: u32, surface: &WlSurface, keys: Vec<u8>)

enter event

Notification that this seat’s keyboard focus is on a certain surface.

The compositor must send the wl_keyboard.modifiers event after this event.

pub fn leave(&self, serial: u32, surface: &WlSurface)

leave event

Notification that this seat’s keyboard focus is no longer on a certain surface.

The leave notification is sent before the enter notification for the new focus.

After this event client must assume that all keys, including modifiers, are lifted and also it must stop key repeating if there’s some going on.

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

key event

A key was pressed or released. The time argument is a timestamp with millisecond granularity, with an undefined base.

The key is a platform-specific key code that can be interpreted by feeding it to the keyboard mapping (see the keymap event).

If this event produces a change in modifiers, then the resulting wl_keyboard.modifiers event must be sent after this event.

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

modifier and group state

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

pub fn repeat_info(&self, rate: i32, delay: i32)

repeat rate and delay

Informs the client about the keyboard’s repeat rate and delay.

This event is sent as soon as the wl_keyboard object has been created, and is guaranteed to be received by the client before any key press event.

Negative values for either rate or delay are illegal. A rate of zero will disable any repeating (regardless of the value of delay).

This event can be sent later on as well with a new value if necessary, so clients should continue listening for the event past the creation of wl_keyboard.

Only available since version 4 of the interface.

Trait Implementations

impl AsRef<Resource<WlKeyboard>> for WlKeyboard

fn as_ref(&self) -> &Resource<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for WlKeyboard

fn clone(&self) -> WlKeyboard

Returns a copy 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

Formats the value using the given formatter.

impl From<Resource<WlKeyboard>> for WlKeyboard

fn from(value: Resource<Self>) -> Self

Converts to this type from the input type.

impl From<WlKeyboard> for Resource<WlKeyboard>

fn from(value: WlKeyboard) -> Self

Converts to this type from the input type.

impl Interface for WlKeyboard

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "wl_keyboard"

Name of this interface

const VERSION: u32 = 7u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<WlKeyboard> for WlKeyboard

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

impl StructuralEq for WlKeyboard

impl StructuralPartialEq for WlKeyboard