MouseRegionModifier class
A widget that tracks the movement of mice.
MouseRegion is used when it is needed to compare the list of objects that a mouse pointer is hovering over between this frame and the last frame. This means entering events, exiting events, and mouse cursors.
To listen to general pointer events, use Listener, or more preferably, GestureDetector.
Layout behavior
See BoxConstraints for an introduction to box layout models.
If it has a child, this widget defers to the child for sizing behavior. If it does not have a child, it grows to fit the parent instead.
{@tool dartpad} This example makes a Container react to being entered by a mouse pointer, showing a count of the number of entries and exits.
** See code in examples/api/lib/widgets/basic/mouse_region.0.dart ** {@end-tool}
See also:
- Listener, a similar widget that tracks pointer events when the pointer has buttons pressed.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SingleChildStatelessModifier
- MouseRegionModifier
- Available extensions
Constructors
- MouseRegionModifier({Key? key, Widget? child, Key? modifierKey, PointerEnterEventListener? onEnter, PointerExitEventListener? onExit, PointerHoverEventListener? onHover, MouseCursor cursor = MouseCursor.defer, bool opaque = true, HitTestBehavior? hitTestBehavior})
-
Creates a widget that forwards mouse events to callbacks.
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
- hitTestBehavior → HitTestBehavior?
-
How to behave during hit testing.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- modifierKey → Key?
-
The actual key of the widget, which Modifier wrapped
finalinherited
- onEnter → PointerEnterEventListener?
-
Triggered when a mouse pointer has entered this widget.
final
- onExit → PointerExitEventListener?
-
Triggered when a mouse pointer has exited this widget when the widget is
still mounted.
final
- onHover → PointerHoverEventListener?
-
Triggered when a pointer moves into a position within this widget without
buttons pressed.
final
- opaque → bool
-
Whether this widget should prevent other MouseRegions visually behind it
from detecting the pointer.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildWithChild(
BuildContext context, Widget? child) → Widget -
A build method that receives an extra
childparameter.override -
createElement(
) → SingleChildStatelessElement -
Create a SingleChildStatelessElement
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
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
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited