core: Dispatch rollOut/rollOver events on focus change and Tab
#15955
Conversation
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
kjarosh
force-pushed
the
tab-ordering-events
branch
5 times, most recently
from
2d1074a to
fc4819a
Compare
adrian17
approved these changes
Apr 21, 2024
core/src/player.rs
Outdated
| } | ||
|
|
||
| impl<'gc> MouseData<'gc> { | ||
| pub fn hovered_object(&self) -> Option<InteractiveObject<'gc>> { |
There was a problem hiding this comment.
I think all these accessors are a bit overly verbose for how simple the struct is; on Discord I proposed making it a fully public struct, or going back to separate fields in UpdateContext (and just making them references)
There was a problem hiding this comment.
Made it a fully public struct, as otherwise the fields would be differentiated by their position in that huge tuple instead of their type in update_context_params.
kjarosh
force-pushed
the
tab-ordering-events
branch
from
fc4819a to
147732e
Compare
Only interactive objects may be focusable, so keeping these methods in all display objects makes matters more difficult, as they also has to be implemented for non-interactive objects. Moving these to InteractiveObject simplifies code in the long run.
Since is_focusable has been moved to InteractiveObject, it may now return true by default, because non-interactive objects do not implement this method anymore.
Using Avm1::run_stack_frame_for_method for calling focus handlers simplifies code and prevents duplication.
UpdateContext.mouse_over_object and UpdateContext.mouse_down_object were treated differently from other properties. Changes made to them were required to be applied manually after using the context. However, when reborrowing the context, all changes made to these properties were dropped, as they were not applied after reborrow. Applying them after reborrow would be difficult (RAII, concurrency problems), that's why they were replaced with mutable references. MouseData struct was introduced to make the code more readable and adhere to the convention of UpdateContext to contain mutable references to higher level objects.
This is a utility method which simplifies getting the current focus as an EditText object, which is being done frequently throughout Ruffle.
Originally, FocusTracker operated on DisplayObjects. However, in both AVM1 and AVM2, all objects that are focusable are InteractiveObjects. Switching FocusTracker to operate on InteractiveObjects simplifies code in the long run.
Since objects may be hovered using Tab, mouse hover update cannot happen every time, because it would always reset the hover set by Tab. This is why mouse hover is skipped when the following are true: 1. the mouse has not moved, 2. no mouse button has been pressed, 3. there was a hover, 4. the hovered object did not disappear.
When focus changes, rollOut/rollOver events should be dispatched. This includes onRollOut/onRollOver handlers, but also button actions.
Extend this test to cover rollOut/rollOver events too.
This test verifies events produced by various interactive objects while tabbing.
This test verifies how the behavior of tabbing is integrated with the mouse with respect to rollOut/rollOver events.
kjarosh
force-pushed
the
tab-ordering-events
branch
from
147732e to
649f7b3
Compare
adrian17
approved these changes
Apr 21, 2024
Lord-McSweeney
removed
the
waiting-on-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to #5443, #15851.
When focus changes,
rollOut/rollOverevents should be dispatched. This includesonRollOut/onRollOverhandlers, but also button actions.This PR includes some code refactors & fixes:
InteractiveObject,FocusTrackernow operates onInteractiveObjects,mouse_over_object&mouse_down_objectfromUpdateContextwere a little broken and were fixed,Two new tests were added:
avm1/tab_ordering_eventsavm1/tab_ordering_events_mouseAnd one was updated (
avm1/selection_handlers) to cover more cases.More detailed descriptions are present in commit messages.