Struct SeatState 

pub struct SeatState { /* private fields */ }

Implementations

impl SeatState

pub fn get_keyboard_with_repeat<D>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, rmlvo: Option<RMLVO>, loop_handle: LoopHandle<'static, D>, callback: RepeatCallback<D>, ) -> Result<WlKeyboard, KeyboardError>

where D: Dispatch<WlKeyboard, KeyboardData<D, ()>> + KeyboardHandler + 'static,

Creates a keyboard from a seat.

This function returns an EventSource that indicates when a key press is going to repeat.

This keyboard implementation uses libxkbcommon for the keymap.

Typically the compositor will provide a keymap, but you may specify your own keymap using the rmlvo field.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a keyboard.

pub fn get_keyboard_with_repeat_with_data<D, U>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, udata: U, loop_handle: LoopHandle<'static, D>, callback: RepeatCallback<D>, ) -> Result<WlKeyboard, KeyboardError>

where D: Dispatch<WlKeyboard, KeyboardData<D, U>> + KeyboardHandler + 'static, U: Send + Sync + 'static,

Creates a keyboard from a seat.

This function returns an EventSource that indicates when a key press is going to repeat.

This keyboard implementation uses libxkbcommon for the keymap.

Typically the compositor will provide a keymap, but you may specify your own keymap using the rmlvo field.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a keyboard.

impl SeatState

pub fn get_keyboard<D>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, rmlvo: Option<RMLVO>, ) -> Result<WlKeyboard, KeyboardError>

where D: Dispatch<WlKeyboard, KeyboardData<D, ()>> + SeatHandler + KeyboardHandler + 'static,

Creates a keyboard from a seat.

This keyboard implementation uses libxkbcommon for the keymap.

Typically the compositor will provide a keymap, but you may specify your own keymap using the rmlvo field.

This keyboard only sends key repeats if they are issued by the compositor. See wl_keyboard version 10.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a keyboard.

pub fn get_keyboard_with_data<D, U>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, udata: U, ) -> Result<WlKeyboard, KeyboardError>

where D: Dispatch<WlKeyboard, KeyboardData<D, U>> + SeatHandler + KeyboardHandler + 'static, U: Send + Sync + 'static,

Creates a keyboard from a seat.

This keyboard implementation uses libxkbcommon for the keymap.

Typically the compositor will provide a keymap, but you may specify your own keymap using the rmlvo field.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a keyboard.

impl SeatState

pub fn new<D: Dispatch<WlSeat, SeatData> + 'static>( global_list: &GlobalList, qh: &QueueHandle<D>, ) -> SeatState

pub fn seats(&self) -> impl Iterator<Item = WlSeat>

Returns an iterator over all the seats.

pub fn info(&self, seat: &WlSeat) -> Option<SeatInfo>

Returns information about a seat.

This will return None if the seat is dead.

pub fn get_pointer<D>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, ) -> Result<WlPointer, SeatError>

where D: Dispatch<WlPointer, PointerData<()>> + PointerHandler + 'static,

Creates a pointer from a seat.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a pointer.

pub fn get_pointer_with_theme<D, S>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, shm: &WlShm, surface: WlSurface, theme: ThemeSpec<'_>, ) -> Result<ThemedPointer<()>, SeatError>

where D: Dispatch<WlPointer, PointerData<()>> + Dispatch<WlSurface, SurfaceData<S>> + Dispatch<WpCursorShapeManagerV1, GlobalData> + Dispatch<WpCursorShapeDeviceV1, GlobalData> + PointerHandler + 'static,

Creates a pointer from a seat with the provided theme.

This will use CursorShapeManager under the hood when it’s available.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a pointer.

pub fn get_pointer_with_data<D, U>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, pointer_data: U, ) -> Result<WlPointer, SeatError>

where D: Dispatch<WlPointer, PointerData<U>> + PointerHandler + 'static, U: Send + Sync + 'static,

Creates a pointer from a seat.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a pointer.

pub fn get_pointer_with_theme_and_data<D, U>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, shm: &WlShm, surface: WlSurface, theme: ThemeSpec<'_>, pointer_data: U, ) -> Result<ThemedPointer<U>, SeatError>

where D: Dispatch<WlPointer, PointerData<U>> + Dispatch<WpCursorShapeManagerV1, GlobalData> + Dispatch<WpCursorShapeDeviceV1, GlobalData> + PointerHandler + 'static, U: Send + Sync + 'static,

Creates a pointer from a seat with the provided theme and data.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support a pointer.

pub fn get_touch<D>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, ) -> Result<WlTouch, SeatError>

where D: Dispatch<WlTouch, TouchData<()>> + TouchHandler + 'static,

Creates a touch handle from a seat.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support touch.

pub fn get_touch_with_data<D, U>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, udata: U, ) -> Result<WlTouch, SeatError>

where D: Dispatch<WlTouch, TouchData<U>> + TouchHandler + 'static, U: Send + Sync + 'static,

Creates a touch handle from a seat.

Errors

This will return SeatError::UnsupportedCapability if the seat does not support touch.

Trait Implementations

impl Debug for SeatState

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

Formats the value using the given formatter.

impl<D> RegistryHandler<D> for SeatState

where D: Dispatch<WlSeat, SeatData> + SeatHandler + ProvidesRegistryState + 'static,

fn new_global( state: &mut D, conn: &Connection, qh: &QueueHandle<D>, name: u32, interface: &str, _: u32, )

Called when a new global has been advertised by the compositor.

fn remove_global( state: &mut D, conn: &Connection, qh: &QueueHandle<D>, name: u32, interface: &str, )

Called when a global has been destroyed by the compositor.