Add key event handlers that happen before or after the focus traversal #136280
Conversation
This file contains hidden or 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
github-actions
bot
added
framework
goderbauer
approved these changes
Oct 10, 2023
Member
goderbauer
left a comment
goderbauer
left a comment
There was a problem hiding this comment.
LGTM, just some doc suggestions.
| typedef FocusOnKeyEventCallback = KeyEventResult Function(FocusNode node, KeyEvent event); | ||
|
|
||
| /// Signature of a callback used by [FocusManager.addEarlyKeyEventHandler] and | ||
| /// [FocusManager.addLateKeyEventHandler]. |
Member
There was a problem hiding this comment.
Can you document the semantics of the argument and return value here?
| /// All of the handlers in the set will be called for every key event the | ||
| /// [FocusManager] receives. If any one of the handlers returns | ||
| /// [KeyEventResult.handled] or [KeyEventResult.skipRemainingHandlers], then | ||
| /// none of the handlers in the focus tree will be called. |
Member
There was a problem hiding this comment.
Maybe link to removeEarlyKeyEventHandler, e.g. in a see also section?
Member
There was a problem hiding this comment.
Maybe also link to addLateKeyEventHandler (and vice versa) just for discoverability?
Member
There was a problem hiding this comment.
For completeness: can you also document the behavior if handlers are added/removed from a OnKeyEventCallback (i.e. while the callbacks are being invoked)?
| /// If the event reaches the root of the focus tree without being handled, | ||
| /// then all of the handlers in the set will be called. If any of them returns | ||
| /// [KeyEventResult.handled] or [KeyEventResult.skipRemainingHandlers], then | ||
| /// event propagation to the platform will be stopped. |
| /// If the event reaches the root of the focus tree without being handled, | ||
| /// then all of the handlers in the set will be called. If any of them returns | ||
| /// [KeyEventResult.handled] or [KeyEventResult.skipRemainingHandlers], then | ||
| /// event propagation to the platform will be stopped. |
Contributor
Author
There was a problem hiding this comment.
Actually, converted this to a macro, since the text is identical.
gspencergoog
added
the
autosubmit
auto-submit
bot
removed
the
autosubmit
Contributor
|
auto label is removed for flutter/flutter/136280, due to - The status or check suite Windows build_tests_4_5 has failed. Please fix the issues identified (or deflake) before re-applying this label. |
gspencergoog
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 11, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 12, 2023
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/packages
that referenced
this pull request
Oct 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This adds a mechanism for listening to key events before or after focus traversal occurs.
It adds four methods to the public
FocusManagerAPI:addEarlyKeyEventHandler- Adds a handler that can handle events before they are given to the focus tree for handling.removeEarlyKeyEventHandler- Removes an early event handler.addLateKeyEventHandler- Adds a handler that can handle events if they have not been handled by anything in the focus tree.removeLateKeyEventHandler- Removes a late event handler.This allows an app to get notified for a key anywhere, and prevent the focus tree from seeing that event if it handles it.
For the menu system, this allows it to eat an escape key press and close all the open menus.
Related Issues
Tests