Enum egui::output::CursorIcon

source ·
pub enum CursorIcon {
Show 35 variants Default, None, ContextMenu, Help, PointingHand, Progress, Wait, Cell, Crosshair, Text, VerticalText, Alias, Copy, Move, NoDrop, NotAllowed, Grab, Grabbing, AllScroll, ResizeHorizontal, ResizeNeSw, ResizeNwSe, ResizeVertical, ResizeEast, ResizeSouthEast, ResizeSouth, ResizeSouthWest, ResizeWest, ResizeNorthWest, ResizeNorth, ResizeNorthEast, ResizeColumn, ResizeRow, ZoomIn, ZoomOut,
}
Expand description

A mouse cursor icon.

egui emits a CursorIcon in PlatformOutput each frame as a request to the integration.

Loosely based on https://developer.mozilla.org/en-US/docs/Web/CSS/cursor.

Variants§

§

Default

Normal cursor icon, whatever that is.

§

None

Show no cursor

§

ContextMenu

A context menu is available

§

Help

Question mark

§

PointingHand

Pointing hand, used for e.g. web links

§

Progress

Shows that processing is being done, but that the program is still interactive.

§

Wait

Not yet ready, try later.

§

Cell

Hover a cell in a table

§

Crosshair

For precision work

§

Text

Text caret, e.g. “Click here to edit text”

§

VerticalText

Vertical text caret, e.g. “Click here to edit vertical text”

§

Alias

Indicated an alias, e.g. a shortcut

§

Copy

Indicate that a copy will be made

§

Move

Omnidirectional move icon (e.g. arrows in all cardinal directions)

§

NoDrop

Can’t drop here

§

NotAllowed

Forbidden

§

Grab

The thing you are hovering can be grabbed

§

Grabbing

You are grabbing the thing you are hovering

§

AllScroll

Something can be scrolled in any direction (panned).

§

ResizeHorizontal

Horizontal resize - to make something wider or more narrow (left to/from right)

§

ResizeNeSw

Diagonal resize / (right-up to/from left-down)

§

ResizeNwSe

Diagonal resize \ (left-up to/from right-down)

§

ResizeVertical

Vertical resize | (up-down or down-up)

§

ResizeEast

Resize something rightwards (e.g. when dragging the right-most edge of something)

§

ResizeSouthEast

Resize something down and right (e.g. when dragging the bottom-right corner of something)

§

ResizeSouth

Resize something downwards (e.g. when dragging the bottom edge of something)

§

ResizeSouthWest

Resize something down and left (e.g. when dragging the bottom-left corner of something)

§

ResizeWest

Resize something leftwards (e.g. when dragging the left edge of something)

§

ResizeNorthWest

Resize something up and left (e.g. when dragging the top-left corner of something)

§

ResizeNorth

Resize something up (e.g. when dragging the top edge of something)

§

ResizeNorthEast

Resize something up and right (e.g. when dragging the top-right corner of something)

§

ResizeColumn

Resize a column

§

ResizeRow

Resize a row

§

ZoomIn

Enhance!

§

ZoomOut

Let’s get a better overview

Implementations§

Trait Implementations§

source§

impl Clone for CursorIcon

source§

fn clone(&self) -> CursorIcon

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CursorIcon

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for CursorIcon

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for CursorIcon

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq for CursorIcon

source§

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

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

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.
source§

impl Serialize for CursorIcon

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for CursorIcon

source§

impl Eq for CursorIcon

source§

impl StructuralPartialEq for CursorIcon

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + Serialize + for<'a> Deserialize<'a> + Send + Sync,