MouseTrackerAnnotation class
The annotation object used to annotate regions that are interested in mouse movements.
To use an annotation, return this object as a HitTestEntry in a hit test. Typically this is implemented by making a RenderBox implement this class (see RenderMouseRegion).
MouseTracker uses this class as a label to filter the hit test results. Hit test entries that are also MouseTrackerAnnotations are considered as valid targets in terms of computing mouse related effects, such as enter events, exit events, and mouse cursor events.
See also:
- MouseTracker, which uses MouseTrackerAnnotation.
- Mixed in types
- Implementers
Constructors
- MouseTrackerAnnotation({PointerEnterEventListener? onEnter, PointerExitEventListener? onExit, MouseCursor cursor = MouseCursor.defer, bool validForMouseTracker = true})
-
Creates an immutable MouseTrackerAnnotation.
const
Properties
- cursor → MouseCursor
-
The mouse cursor for mouse pointers that are hovering over the region.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- onEnter → PointerEnterEventListener?
-
Triggered when a mouse pointer, with or without buttons pressed, has
entered the region and validForMouseTracker is true.
final
- onExit → PointerExitEventListener?
-
Triggered when a mouse pointer, with or without buttons pressed, has
exited the region and validForMouseTracker is true.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- validForMouseTracker → bool
-
Whether this is included when MouseTracker collects the list of
annotations.
final
Methods
-
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.
inherited