Struct wlroots::cursor::xcursor::Theme

pub struct Theme { /* fields omitted */ }

Wrapper for an xcursor theme from the X11 xcursor library.

Xcursor (mostly) follows the freedesktop.org spec for theming icons.

Methods

impl Theme

pub fn load_theme<T: Into<Option<String>>>(name: T, size: c_int) -> Option<Self>

Loads the named xcursor theme at the given cursor size (in pixels).

This is useful if you need cursor images for your compositor to use when a client-side cursors is not available or you wish to override client-side cursors for a particular UI interaction (such as using a grab cursor when moving a window around)

The default search path it uses is ~/.icons, /usr/share/icons, /usr/share/pixmaps. Within each of these directories, it searches for a directory using the theme name. Within the theme directory, it looks for cursor files in the 'cursors' subdirectory. It uses the first cursor file found along the path.

If necessary, Xcursor also looks for a "index.theme" file in each theme directory to find inherited themes and searches along the path for those themes as well.

If no name is given, defaults to "default". If no theme can be found None is returned.

pub fn name(&self) -> Option<String>

Get the name of this theme.

If the name returned by wlroots was malformed, or nonexistent, then the value will be None.

pub fn size(&self) -> c_int

Get the size of the images.

pub fn cursor_count(&self) -> usize

Get the number of cursors in this theme.

pub fn cursors<'theme>(&'theme mut self) -> Vec<XCursor<'theme>>

Gets all the cursors from this theme.

pub fn get_cursor<'theme>(&'theme self, name: String) -> Option<XCursor<'theme>>

Get the cursor with the provided name (e.g. "left_ptr"), if it exists.

pub unsafe fn from_ptr(theme: *mut wlr_xcursor_theme) -> Theme

Constructs a Theme from a raw pointer.

Unsafety

Takes ownership of the cursor theme. When the Theme is dropped it calls wlr_cursor_theme_destroy.

Trait Implementations

impl Drop for Theme

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Theme

impl PartialOrd<Theme> for Theme

fn partial_cmp(&self, other: &Theme) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Theme) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Theme) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Theme) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Theme) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Theme> for Theme

fn eq(&self, other: &Theme) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Theme) -> bool

This method tests for !=.

impl Ord for Theme

fn cmp(&self, other: &Theme) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for Theme

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Debug for Theme

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

Formats the value using the given formatter.