Enum wayland_csd_frame::CursorIcon

#[non_exhaustive]
pub enum CursorIcon {
    Default,
    ContextMenu,
    Help,
    Pointer,
    Progress,
    Wait,
    Cell,
    Crosshair,
    Text,
    VerticalText,
    Alias,
    Copy,
    Move,
    NoDrop,
    NotAllowed,
    Grab,
    Grabbing,
    EResize,
    NResize,
    NeResize,
    NwResize,
    SResize,
    SeResize,
    SwResize,
    WResize,
    EwResize,
    NsResize,
    NeswResize,
    NwseResize,
    ColResize,
    RowResize,
    AllScroll,
    ZoomIn,
    ZoomOut,
}

Describes the appearance of the (usually mouse) cursor icon.

The names are taken from the CSS W3C specification: https://www.w3.org/TR/css-ui-3/#cursor

Examples

use cursor_icon::CursorIcon;

// Get the cursor icon for the default cursor.
let cursor_icon = CursorIcon::Default;

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The platform-dependent default cursor. Often rendered as arrow.

ContextMenu

A context menu is available for the object under the cursor. Often rendered as an arrow with a small menu-like graphic next to it.

Help

Help is available for the object under the cursor. Often rendered as a question mark or a balloon.

Pointer

The cursor is a pointer that indicates a link. Often rendered as the backside of a hand with the index finger extended.

Progress

A progress indicator. The program is performing some processing, but is different from CursorIcon::Wait in that the user may still interact with the program.

Wait

Indicates that the program is busy and the user should wait. Often rendered as a watch or hourglass.

Cell

Indicates that a cell or set of cells may be selected. Often rendered as a thick plus-sign with a dot in the middle.

Crosshair

A simple crosshair (e.g., short line segments resembling a “+” sign). Often used to indicate a two dimensional bitmap selection mode.

Text

Indicates text that may be selected. Often rendered as an I-beam.

VerticalText

Indicates vertical-text that may be selected. Often rendered as a horizontal I-beam.

Alias

Indicates an alias of/shortcut to something is to be created. Often rendered as an arrow with a small curved arrow next to it.

Copy

Indicates something is to be copied. Often rendered as an arrow with a small plus sign next to it.

Move

Indicates something is to be moved.

NoDrop

Indicates that the dragged item cannot be dropped at the current cursor location. Often rendered as a hand or pointer with a small circle with a line through it.

NotAllowed

Indicates that the requested action will not be carried out. Often rendered as a circle with a line through it.

Grab

Indicates that something can be grabbed (dragged to be moved). Often rendered as the backside of an open hand.

Grabbing

Indicates that something is being grabbed (dragged to be moved). Often rendered as the backside of a hand with fingers closed mostly out of view.

EResize

The east border to be moved.

NResize

The north border to be moved.

NeResize

The north-east corner to be moved.

NwResize

The north-west corner to be moved.

SResize

The south border to be moved.

SeResize

The south-east corner to be moved.

SwResize

The south-west corner to be moved.

WResize

The west border to be moved.

EwResize

The east and west borders to be moved.

NsResize

The south and north borders to be moved.

NeswResize

The north-east and south-west corners to be moved.

NwseResize

The north-west and south-east corners to be moved.

ColResize

Indicates that the item/column can be resized horizontally. Often rendered as arrows pointing left and right with a vertical bar separating them.

RowResize

Indicates that the item/row can be resized vertically. Often rendered as arrows pointing up and down with a horizontal bar separating them.

AllScroll

Indicates that the something can be scrolled in any direction. Often rendered as arrows pointing up, down, left, and right with a dot in the middle.

ZoomIn

Indicates that something can be zoomed in. Often rendered as a magnifying glass with a “+” in the center of the glass.

ZoomOut

Indicates that something can be zoomed in. Often rendered as a magnifying glass with a “-” in the center of the glass.

Implementations

impl CursorIcon

pub fn name(&self) -> &'static str

The name of the cursor icon as defined in w3c standard.

This name most of the time could be passed as is to cursor loading libraries on X11/Wayland and could be used as-is on web.

Examples

use cursor_icon::CursorIcon;
use wayland_cursor::CursorTheme;

// Choose a cursor to load.
let cursor = CursorIcon::Help;

// Load the Wayland cursor theme.
let mut cursor_theme = CursorTheme::load(conn, shm, 32)?;

// Load the cursor.
let cursor = cursor_theme.get_cursor(cursor.name());
if let Some(cursor) = cursor {
    println!("Total number of images: {}", cursor.image_count());
}

pub fn alt_names(&self) -> &[&'static str]

A list of alternative names for the cursor icon as commonly found in legacy Xcursor themes.

This should only be used as a fallback in case the cursor theme does not adhere to the w3c standard.

Trait Implementations

impl Clone for CursorIcon

fn clone(&self) -> CursorIcon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CursorIcon

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

Formats the value using the given formatter.

impl Default for CursorIcon

fn default() -> CursorIcon

Returns the “default value” for a type.

impl Display for CursorIcon

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

Formats the value using the given formatter.

impl FromStr for CursorIcon

fn from_str(name: &str) -> Result<CursorIcon, <CursorIcon as FromStr>::Err>

Parse a string slice into CursorIcon.

The name is a lower kebab case CursorIcon varaint name, e.g. nesw-resize. The set of possible valid name values matches exactly the set of CursorIcon::name outputs.

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for CursorIcon

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CursorIcon

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CursorIcon

impl Eq for CursorIcon

impl StructuralPartialEq for CursorIcon