Struct SeatState

pub struct SeatState { /* private fields */ }

Available on crate feature wayland and Linux only.

Implementations

impl SeatState

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

where D: Dispatch<WlKeyboard, KeyboardData<T>> + KeyboardHandler + 'static, T: '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, <U as KeyboardDataExt>::State>, callback: Box<dyn FnMut(&mut <U as KeyboardDataExt>::State, &WlKeyboard, KeyEvent)>, ) -> Result<WlKeyboard, KeyboardError>

where D: Dispatch<WlKeyboard, U> + KeyboardHandler + 'static, U: KeyboardDataExt + '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, T>( &mut self, qh: &QueueHandle<D>, seat: &WlSeat, rmlvo: Option<RMLVO>, ) -> Result<WlKeyboard, KeyboardError>

where T: 'static, D: Dispatch<WlKeyboard, KeyboardData<T>> + 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, U> + SeatHandler + KeyboardHandler + 'static, U: KeyboardDataExt + '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>(global_list: &GlobalList, qh: &QueueHandle<D>) -> SeatState

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

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, S> + Dispatch<WpCursorShapeManagerV1, GlobalData> + Dispatch<WpCursorShapeDeviceV1, GlobalData> + PointerHandler + 'static, S: SurfaceDataExt + '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, U> + PointerHandler + 'static, U: PointerDataExt + '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, S, 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, U> + Dispatch<WlSurface, S> + Dispatch<WpCursorShapeManagerV1, GlobalData> + Dispatch<WpCursorShapeDeviceV1, GlobalData> + PointerHandler + 'static, S: SurfaceDataExt + 'static, U: PointerDataExt + '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, U> + TouchHandler + 'static, U: TouchDataExt + '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<(), 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<D, U> Dispatch<WlPointer, U, D> for SeatState

where D: Dispatch<WlPointer, U> + PointerHandler, U: PointerDataExt,

fn event( data: &mut D, pointer: &WlPointer, 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<D> Dispatch<WlSeat, SeatData, D> for SeatState

where D: Dispatch<WlSeat, SeatData> + SeatHandler,

fn event( state: &mut D, seat: &WlSeat, event: Event, data: &SeatData, 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<D, U> Dispatch<WlTouch, U, D> for SeatState

where D: Dispatch<WlTouch, U> + TouchHandler, U: TouchDataExt,

fn event( data: &mut D, touch: &WlTouch, 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 Dispatch<WpCursorShapeDeviceV1, GlobalData, WinitState> for SeatState

fn event( _: &mut WinitState, _: &WpCursorShapeDeviceV1, _: <WpCursorShapeDeviceV1 as Proxy>::Event, _: &GlobalData, _: &Connection, _: &QueueHandle<WinitState>, )

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 Dispatch<WpCursorShapeManagerV1, GlobalData, WinitState> for SeatState

fn event( _: &mut WinitState, _: &WpCursorShapeManagerV1, _: <WpCursorShapeManagerV1 as Proxy>::Event, _: &GlobalData, _: &Connection, _: &QueueHandle<WinitState>, )

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<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.