Split Mouse from Listener #36217
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2460,43 +2460,31 @@ typedef PointerCancelEventListener = void Function(PointerCancelEvent event); | |
| /// Used by [Listener] and [RenderPointerListener]. | ||
| typedef PointerSignalEventListener = void Function(PointerSignalEvent event); | ||
|
|
||
| /// Calls callbacks in response to common pointer events. | ||
| /// | ||
| /// It responds to events that can construct gestures, such as when the | ||
| /// pointer is pressed, moved, then released or canceled. | ||
| /// | ||
| /// It does not respond to events that are exclusive to mouse, such as when the | ||
| /// mouse enters, exits or hovers a region without pressing any buttons. For | ||
| /// these events, use [RenderMouseRegion]. | ||
| /// | ||
| /// If it has a child, defers to the child for sizing behavior. | ||
| /// | ||
| /// If it does not have a child, grows to fit the parent-provided constraints. | ||
| class RenderPointerListener extends RenderProxyBoxWithHitTestBehavior { | ||
| /// Creates a render object that forwards pointer events to callbacks. | ||
| /// | ||
| /// The [behavior] argument defaults to [HitTestBehavior.deferToChild]. | ||
| RenderPointerListener({ | ||
| this.onPointerDown, | ||
| this.onPointerMove, | ||
| this.onPointerUp, | ||
| this.onPointerCancel, | ||
| this.onPointerSignal, | ||
| HitTestBehavior behavior = HitTestBehavior.deferToChild, | ||
| RenderBox child, | ||
| }) : super(behavior: behavior, child: child); | ||
|
|
||
| /// Called when a pointer comes into contact with the screen (for touch | ||
| /// pointers), or has its button pressed (for mouse pointers) at this widget's | ||
|
|
@@ -2506,55 +2494,129 @@ class RenderPointerListener extends RenderProxyBoxWithHitTestBehavior { | |
| /// Called when a pointer that triggered an [onPointerDown] changes position. | ||
| PointerMoveEventListener onPointerMove; | ||
|
|
||
| /// Called when a pointer that triggered an [onPointerDown] is no longer in | ||
| /// contact with the screen. | ||
| PointerUpEventListener onPointerUp; | ||
|
|
||
| /// Called when the input from a pointer that triggered an [onPointerDown] is | ||
| /// no longer directed towards this receiver. | ||
| PointerCancelEventListener onPointerCancel; | ||
|
|
||
| /// Called when a pointer signal occurs over this object. | ||
| PointerSignalEventListener onPointerSignal; | ||
|
|
||
| @override | ||
| void performResize() { | ||
| size = constraints.biggest; | ||
| } | ||
|
|
||
| @override | ||
| void handleEvent(PointerEvent event, HitTestEntry entry) { | ||
| assert(debugHandleEvent(event, entry)); | ||
| if (onPointerDown != null && event is PointerDownEvent) | ||
| return onPointerDown(event); | ||
| if (onPointerMove != null && event is PointerMoveEvent) | ||
| return onPointerMove(event); | ||
| if (onPointerUp != null && event is PointerUpEvent) | ||
| return onPointerUp(event); | ||
| if (onPointerCancel != null && event is PointerCancelEvent) | ||
| return onPointerCancel(event); | ||
| if (onPointerSignal != null && event is PointerSignalEvent) | ||
| return onPointerSignal(event); | ||
| } | ||
|
|
||
| @override | ||
| void debugFillProperties(DiagnosticPropertiesBuilder properties) { | ||
| super.debugFillProperties(properties); | ||
| final List<String> listeners = <String>[]; | ||
| if (onPointerDown != null) | ||
| listeners.add('down'); | ||
| if (onPointerMove != null) | ||
| listeners.add('move'); | ||
| if (onPointerUp != null) | ||
| listeners.add('up'); | ||
| if (onPointerCancel != null) | ||
| listeners.add('cancel'); | ||
| if (onPointerSignal != null) | ||
| listeners.add('signal'); | ||
| if (listeners.isEmpty) | ||
| listeners.add('<none>'); | ||
| properties.add(IterableProperty<String>('listeners', listeners)); | ||
| // TODO(jacobr): add raw listeners to the diagnostics data. | ||
|
There was a problem hiding this comment. @jacob314 Is there anything special we need to do to resolve this TODO? There was a problem hiding this comment. properties.add(ObjectFlagProperty<PointerDownEventListener>('onPointerDown', onPointerDown, ifPresent: 'down', level: DiagnosticLevel.fine);Would be an idiomatic way to expose each of these. There was a problem hiding this comment. @jacob314 or Is there a way to maintain the current format while using There was a problem hiding this comment. Not currently. Are there any cases with a subclass that wants to add an additional listener? In that case it could make sense to come up with a scheme that enables defining each listener as an ObjectFlagProperty and then aggregate the properties into a terse summary like |
||
| } | ||
| } | ||
|
|
||
| /// Calls callbacks in response to pointer events that are exclusive to mice. | ||
| /// | ||
| /// Simply put, it responds to events that are related to hovering, | ||
| /// i.e. when the mouse enters, exits or hovers a region without pressing. | ||
| /// | ||
| /// It does not respond to common events that construct gestures, such as when | ||
| /// the pointer is pressed, moved, then released or canceled. For these events, | ||
| /// use [RenderPointerListener]. | ||
| /// | ||
| /// If it has a child, it defers to the child for sizing behavior. | ||
| /// | ||
| /// If it does not have a child, it grows to fit the parent-provided constraints. | ||
| class RenderMouseRegion extends RenderProxyBox { | ||
| /// Creates a render object that forwards pointer events to callbacks. | ||
dkwingsmt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| RenderMouseRegion({ | ||
| PointerEnterEventListener onEnter, | ||
| PointerHoverEventListener onHover, | ||
| PointerExitEventListener onExit, | ||
| RenderBox child, | ||
| }) : _onEnter = onEnter, | ||
| _onHover = onHover, | ||
| _onExit = onExit, | ||
| super(child) { | ||
| if (_onEnter != null || _onHover != null || _onExit != null) { | ||
| _hoverAnnotation = MouseTrackerAnnotation( | ||
| onEnter: _onEnter, | ||
| onHover: _onHover, | ||
| onExit: _onExit, | ||
| ); | ||
| } | ||
| _mouseIsConnected = RendererBinding.instance.mouseTracker.mouseIsConnected; | ||
| } | ||
|
|
||
| /// Called when a hovering pointer enters the region for this widget. | ||
| /// | ||
| /// If this is a mouse pointer, this will fire when the mouse pointer enters | ||
| /// the region defined by this widget. | ||
| PointerEnterEventListener get onEnter => _onEnter; | ||
|
There was a problem hiding this comment. It's too bad we can't now name these |
||
| set onEnter(PointerEnterEventListener value) { | ||
| if (_onEnter != value) { | ||
| _onEnter = value; | ||
| _updateAnnotations(); | ||
| } | ||
| } | ||
| PointerEnterEventListener _onEnter; | ||
|
|
||
| /// Called when a pointer that has not triggered an [onPointerDown] changes | ||
| /// position. | ||
| /// | ||
| /// Typically only triggered for mouse pointers. | ||
| PointerHoverEventListener get onHover => _onHover; | ||
| set onHover(PointerHoverEventListener value) { | ||
| if (_onHover != value) { | ||
| _onHover = value; | ||
| _updateAnnotations(); | ||
| } | ||
| } | ||
| PointerHoverEventListener _onHover; | ||
|
|
||
| /// Called when a hovering pointer leaves the region for this widget. | ||
| /// | ||
| /// If this is a mouse pointer, this will fire when the mouse pointer leaves | ||
| /// the region defined by this widget. | ||
| PointerExitEventListener get onExit => _onExit; | ||
| set onExit(PointerExitEventListener value) { | ||
| if (_onExit != value) { | ||
| _onExit = value; | ||
| _updateAnnotations(); | ||
| } | ||
| } | ||
| PointerExitEventListener _onExit; | ||
|
|
||
| // Object used for annotation of the layer used for hover hit detection. | ||
| MouseTrackerAnnotation _hoverAnnotation; | ||
|
|
@@ -2567,19 +2629,19 @@ class RenderPointerListener extends RenderProxyBoxWithHitTestBehavior { | |
| MouseTrackerAnnotation get hoverAnnotation => _hoverAnnotation; | ||
|
|
||
| void _updateAnnotations() { | ||
| assert(_hoverAnnotation == null || _onEnter != _hoverAnnotation.onEnter || _onHover != _hoverAnnotation.onHover || _onExit != _hoverAnnotation.onExit, | ||
| "Shouldn't call _updateAnnotations if nothing has changed."); | ||
| bool changed = false; | ||
| final bool hadHoverAnnotation = _hoverAnnotation != null; | ||
| if (_hoverAnnotation != null && attached) { | ||
| RendererBinding.instance.mouseTracker.detachAnnotation(_hoverAnnotation); | ||
| changed = true; | ||
| } | ||
| if (_onEnter != null || _onHover != null || _onExit != null) { | ||
| _hoverAnnotation = MouseTrackerAnnotation( | ||
| onEnter: _onEnter, | ||
| onHover: _onHover, | ||
| onExit: _onExit, | ||
| ); | ||
| if (attached) { | ||
| RendererBinding.instance.mouseTracker.attachAnnotation(_hoverAnnotation); | ||
|
|
@@ -2674,43 +2736,16 @@ class RenderPointerListener extends RenderProxyBoxWithHitTestBehavior { | |
| size = constraints.biggest; | ||
| } | ||
|
|
||
| @override | ||
| void debugFillProperties(DiagnosticPropertiesBuilder properties) { | ||
| super.debugFillProperties(properties); | ||
| final List<String> listeners = <String>[]; | ||
| if (onEnter != null) | ||
| listeners.add('enter'); | ||
| if (onHover != null) | ||
| listeners.add('hover'); | ||
| if (onExit != null) | ||
| listeners.add('exit'); | ||
| if (listeners.isEmpty) | ||
| listeners.add('<none>'); | ||
| properties.add(IterableProperty<String>('listeners', listeners)); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why do we use methods in the previous two files and closures here? we should be consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, but I'm leaning towards making as few changes in other files as possible since it's a breaking PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure why it being a breaking PR matters here?
But if you want to change it in another PR that's fine. :-)