Skip to main content

SystemMouseCursor

Struct SystemMouseCursor 

Source
pub struct SystemMouseCursor { /* private fields */ }
Expand description

A mouse cursor that is natively supported on the platform that the application is running on.

System cursors can be used without external resources, and their appearances match the experience of native apps. Examples of system cursors are a pointing arrow, a pointing hand, a double arrow for resizing, or a text I-beam, etc.

An instance of SystemMouseCursor refers to one cursor from each platform that represents the same concept, such as being text, being clickable, or being a forbidden operation. Since the set of system cursors supported by each platform varies, multiple instances can correspond to the same system cursor.

Each cursor is noted with its corresponding native cursors on each platform:

  • Android: API name in Java
  • Web: CSS cursor
  • Windows: Win32 API
  • Linux: GDK, gdk_cursor_new_from_name
  • macOS: API name in ObjectiveC

If the platform that the application is running on is not listed for a cursor, using this cursor falls back to SystemMouseCursors::BASIC.

SystemMouseCursors enumerates the complete set of system cursors supported by Flutter, which are hard-coded in the engine. Therefore, manually instantiating this class is not supported.

Implementations§

Source§

impl SystemMouseCursor

Source

pub fn kind(&self) -> SystemMouseCursorKind

The kind of the cursor.

The interpretation of kind is platform-dependent.

Trait Implementations§

Source§

impl Clone for SystemMouseCursor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SystemMouseCursor

Source§

impl Debug for SystemMouseCursor

Source§

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

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

impl Eq for SystemMouseCursor

Source§

impl From<SystemMouseCursor> for MouseCursorRef

Source§

fn from(cursor: SystemMouseCursor) -> MouseCursorRef

Converts to this type from the input type.
Source§

impl Hash for SystemMouseCursor

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl MouseCursor for SystemMouseCursor

Source§

fn create_session(&self, device: i64) -> Box<dyn MouseCursorSession>

Associate a pointing device to this cursor. Read more
Source§

fn debug_description(&self) -> String

A very short description of the mouse cursor. Read more
Source§

fn as_any(&self) -> &dyn Any

Downcast support for Dart’s == between cursor classes.
Source§

fn eq_cursor(&self, other: &dyn MouseCursor) -> bool

Dart’s ==. Identity unless a class overrides it, as SystemMouseCursor does.
Source§

fn is_defer(&self) -> bool

Whether this is MouseCursor.defer.
Source§

impl PartialEq for SystemMouseCursor

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SystemMouseCursor

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,