Enum bevy::window::CursorIcon

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

The icon to display for a window’s cursor.

Examples of all of these cursors can be found here. This enum is simply a copy of a similar enum found in winit. winit, in turn, mostly copied cursor types available in the browser.

Variants

Default

The platform-dependent default cursor.

Crosshair

A simple crosshair.

Hand

A hand (often used to indicate links in web browsers).

Arrow

An arrow. This is the default cursor on most systems.

Move

Indicates something is to be moved.

Text

Indicates text that may be selected or edited.

Wait

Program busy indicator.

Help

Help indicator (often rendered as a “?”)

Progress

Progress indicator. Shows that processing is being done.

But in contrast with “Wait” the user may still interact with the program. Often rendered as a spinning beach ball, or an arrow with a watch or hourglass.

NotAllowed

Cursor showing that something cannot be done.

ContextMenu

Indicates that a context menu is available.

Cell

Indicates that a cell (or set of cells) may be selected.

VerticalText

Indicates vertical text that may be selected or edited.

Alias

Indicates that an alias of something is to be created.

Copy

Indicates something is to be copied.

NoDrop

Indicates that the dragged item cannot be dropped here.

Grab

Indicates that something can be grabbed.

Grabbing

Indicates that something is grabbed.

AllScroll

Indicates that the user can scroll by dragging the mouse.

ZoomIn

Indicates that the user can zoom in.

ZoomOut

Indicates that the user can zoom out.

EResize

Indicates that an edge of a box is to be moved right (east).

NResize

Indicates that an edge of a box is to be moved up (north).

NeResize

Indicates that an edge of a box is to be moved up and right (north/east).

NwResize

indicates that an edge of a box is to be moved up and left (north/west).

SResize

Indicates that an edge of a box is to be moved down (south).

SeResize

The cursor indicates that an edge of a box is to be moved down and right (south/east).

SwResize

The cursor indicates that an edge of a box is to be moved down and left (south/west).

WResize

Indicates that an edge of a box is to be moved left (west).

EwResize

Indicates a bidirectional resize cursor.

NsResize

Indicates a bidirectional resize cursor.

NeswResize

Indicates a bidirectional resize cursor.

NwseResize

Indicates a bidirectional resize cursor.

ColResize

Indicates that a column can be resized horizontally.

RowResize

Indicates that the row can be resized vertically.

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 Enum for CursorIcon

fn field(&self, __name_param: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for CursorIcon

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<CursorIcon>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect + 'static, Global> ) -> Result<Self, Box<dyn Reflect + 'static, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for CursorIcon

fn get_type_registration() -> TypeRegistration

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<CursorIcon> 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 Reflect for CursorIcon

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type.

fn into_any(self: Box<CursorIcon, Global>) -> Box<dyn Any + 'static, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect( self: Box<CursorIcon, Global> ) -> Box<dyn Reflect + 'static, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect + 'static, Global> ) -> Result<(), Box<dyn Reflect + 'static, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<CursorIcon, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

impl Typed for CursorIcon

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for CursorIcon

impl Eq for CursorIcon

impl StructuralEq for CursorIcon

impl StructuralPartialEq for CursorIcon