Struct smithay_client_toolkit::pointer::ThemedPointer

pub struct ThemedPointer { /* fields omitted */ }

Wrapper of a themed pointer

You can access the underlying Proxy<wl_pointer::WlPointer> via deref. It will not release the proxy when dropped.

Just like Proxy, this is a Rc-like wrapper. You can clone it to have several handles to the same theming machinery of a pointer.

Methods

impl ThemedPointer

pub fn set_cursor(&self, name: &str, serial: Option<u32>) -> Result<(), ()>

Change the cursor to the given cursor name

Possible names depend on the theme. Does nothing and returns Err(()) if given name is not available.

If this is done as an answer to an input event, you need to provide the associated serial otherwise the server may ignore the request.

Trait Implementations

impl Clone for ThemedPointer

fn clone(&self) -> ThemedPointer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ThemedPointer

type Target = Proxy<WlPointer>

The resulting type after dereferencing.

fn deref(&self) -> &Proxy<WlPointer>

Dereferences the value.