SystemMouseCursor class
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
- Windows UWP: WinRT API,
winrt::Windows::UI::Core::CoreCursorType - Linux: GDK,
gdk_cursor_new_from_name - macOS: API name in Objective C
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.
- Inheritance
-
- Object
- MouseCursor
- SystemMouseCursor
Properties
- debugDescription → String
-
A very short description of the mouse cursor.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setteroverride
- kind → String
-
A string that identifies the kind of the cursor.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createSession(
int device) → MouseCursorSession -
Associate a pointing device to this cursor.
override
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override