Struct wayland_server::protocol::wl_keyboard::WlKeyboard

pub struct WlKeyboard { /* fields omitted */ }

Methods

impl WlKeyboard

fn keymap(&self, format: KeymapFormat, fd: RawFd, size: u32) -> EventResult<()>

keyboard mapping

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

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

enter event

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

fn leave(&self, serial: u32, surface: &WlSurface) -> EventResult<()>

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.

fn key(
    &self,
    serial: u32,
    time: u32,
    key: u32,
    state: KeyState
) -> EventResult<()>

key event

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

fn modifiers(
    &self,
    serial: u32,
    mods_depressed: u32,
    mods_latched: u32,
    mods_locked: u32,
    group: u32
) -> EventResult<()>

modifier and group state

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

fn repeat_info(&self, rate: i32, delay: i32) -> EventResult<()>

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.

This event is only available since version 4 of the interface

Trait Implementations

impl Send for WlKeyboard

impl Sync for WlKeyboard

impl Resource for WlKeyboard

fn ptr(&self) -> *mut wl_resource

Pointer to the underlying wayland proxy object

unsafe fn from_ptr_new(ptr: *mut wl_resource) -> WlKeyboard

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_resource) -> WlKeyboard

Create an instance from a wayland pointer

fn interface_ptr() -> *const wl_interface

Pointer to the interface representation

fn interface_name() -> &'static str

Internal wayland name of this interface

fn supported_version() -> u32

Max version of this interface supported

fn version(&self) -> i32

Current version of the interface this resource is instantiated with

fn status(&self) -> Liveness

Check if the resource behind this handle is actually still alive

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

Check of two handles are actually the same wayland object

fn set_user_data(&self, ptr: *mut ())

Set a pointer associated as user data on this resource

fn get_user_data(&self) -> *mut ()

Get the pointer associated as user data on this resource

unsafe fn clone_unchecked(&self) -> WlKeyboard

Unsafely clone this resource handle

fn post_error(&self, error_code: u32, msg: String)

Posts a protocol error to this resource

fn clone(&self) -> Option<Self> where
    Self: Sized, 

Clone this resource handle

fn same_client_as<R: Resource>(&self, other: &R) -> bool

Checks wether this resource and the other are from the same client

impl<ID: 'static> Implementable<ID> for WlKeyboard

type Implementation = Implementation<ID>

The type containing the implementation for the event callbacks

unsafe fn __dispatch_msg(
    &self,
    client: &Client,
    opcode: u32,
    args: *const wl_argument
) -> Result<(), ()>