Struct smithay::wayland::tablet_manager::TabletSeatHandle

pub struct TabletSeatHandle { /* fields omitted */ }

Handle to a tablet seat

TabletSeat extends Seat with graphic tablet specific functionality

TabletSeatHandle can be used to advertise available graphics tablets and tools to wayland clients

Implementations

impl TabletSeatHandle

pub fn on_cursor_surface<F>(&mut self, cb: F) where
    F: FnMut(&TabletToolDescriptor, CursorImageStatus) + 'static, 

Add a callback to SetCursor event

pub fn add_tablet(&self, tablet_desc: &TabletDescriptor) -> TabletHandle

Add a new tablet to a seat.

You can either add tablet on input::Event::DeviceAdded event, or you can add tablet based on tool event, then clients will not know about devices that are not being used

Returns new TabletHandle if tablet was not know by this seat, if tablet was already know it returns existing handle.

pub fn get_tablet(&self, tablet_desc: &TabletDescriptor) -> Option<TabletHandle>

Get a handle to a tablet

pub fn count_tablets(&self) -> usize

Count all tablet devices

pub fn remove_tablet(&self, tablet_desc: &TabletDescriptor)

Remove tablet device

Called when tablet is no longer available For example on input::Event::DeviceRemoved event.

pub fn clear_tablets(&self)

Remove all tablet devices

pub fn add_tool(&self, tool_desc: &TabletToolDescriptor) -> TabletToolHandle

Add a new tool to a seat.

Tool is usually added on TabletToolProximityEvent event.

Returns new TabletToolHandle if tool was not know by this seat, if tool was already know it returns existing handle, it allows you to send tool input events to clients.

pub fn get_tool(
    &self,
    tool_desc: &TabletToolDescriptor
) -> Option<TabletToolHandle>

Get a handle to a tablet tool

pub fn count_tools(&self) -> usize

Count all tablet tool devices

pub fn remove_tool(&self, tool_desc: &TabletToolDescriptor)

Remove tablet tool device

Policy of tool removal is a compositor-specific.

One possible policy would be to remove a tool when all tablets the tool was used on are removed.

pub fn clear_tools(&self)

Remove all tablet tool devices

Trait Implementations

impl Clone for TabletSeatHandle

fn clone(&self) -> TabletSeatHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TabletSeatHandle

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

Formats the value using the given formatter.

impl Default for TabletSeatHandle

fn default() -> TabletSeatHandle

Returns the “default value” for a type.