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

impl CursorIcon

pub const ALL: [CursorIcon ; 35] = _

Trait Implementations

impl Clone for CursorIcon

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

impl Debug for CursorIcon

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

Formats the value using the given formatter. Read more

impl Default for CursorIcon

fn default() -> Self

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

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

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

Deserialize this value from the given Serde deserializer. Read more

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 ==. Read more

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. Read more

impl Serialize for CursorIcon

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

Serialize this value into the given Serde serializer. Read more

impl Copy for CursorIcon

impl StructuralPartialEq for CursorIcon

Auto Trait Implementations

impl RefUnwindSafe for CursorIcon

impl Send for CursorIcon

impl Sync for CursorIcon

impl Unpin for CursorIcon

impl UnwindSafe for CursorIcon

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

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