Windows 11 emoji panel/navigation menu item: handle UIA elemenet selected event by ignoring it or manipulating NVDA's focus object #16555
Conversation
…avigation menu item. Define a dedicated overlay class for Windows 11 emoji panel navigation menu items (deriving from UIA list item class) to handle elemenet selected event and others if needed. This keeps the element selectd event handler defined in the app module simple.
…ion Id string staring with 'navigation-menu-item' as navigation menu item class. Rework list item recognition: if encountering a list item, differentiate between IME candidate items and Windows 11 emoji panel navigation menu items.
…ass handle the event. Allow Windows 11 emoji panel navigation menu item overlay class to handle UIA element selected evnt in situations such as element selected event being fired when emoji panel closes in Windows 11.
…event if the event fires when the emoji panel is closed. Re nvaccess#16346. Define UIA element selected event for navigation menu item overlay class, designed to ignore the event when conditions arise. The first condition is event being fired when closing the emoji panel - check the app modules and ignore the event if the focused app module is not the emoji panel app module, utilizing Python 3.8's assignment expression (:=) syntax (focus object is neeeded in other conditions).
… item when apropriate. Re nvaccess#16346. Report the selected menu item when ignore conditions are dealt with.
…oji panel is closed and emoji search field is offscreen. Re nvaccess#16346. Unlike the event ignore condition, NVDA's focus object stays on emoji edit field when the panel is closed, leaving it offscren. In this case, NVDA does not know where to move the 'focus object' to. Therefore, tell NVDA to queue gain focus event on the system focus control returned by obj.objectWithFocus() method.
…event if menu items are gaining focus. Re nvaccess#16532. Gain focus event is fired by navigation menu itmes if the panel is open to clipboard history, resulting in repetitions (both gain focus and element selected events are fired for clipboard history item). Ignore the element selected event so gain focus event can announce the selected menu item.
…viewing kaomojis and symbols in fullscreen. Re nvaccess#16533. Gain focus event is fired when moving through kaomoji and symbol entries. When Tab is pressed, both gain focus and elemenet selected events are fired. Therefore, trust the gain focus event.
…m focus when emoji panel main window unexpected gains focus accompanied by elemenet selected event. Re nvaccess#16347. A variation of issue 16347: sometimes when closing emoji panel/clipboard history, input experience main window grabs NVDA's focus accompanied with UIA element selected event. The gain focus event handler defined at the app module level only manipulates focus if no events are pending, but inthis case, events were pending. Therefore, catch this and manipulate NVDA focus if NVDA finds itself stuck in emoji panel main window element while handling element selected event.
|
Note: changelog wil be written after giving CodeRabbitAI bot a chance to check this PR. |
|
Hi @josephsl - I've turned off automatic CodeRabbit reviews for now until we are happy with the type of feedback being given. They can still be manually triggered with @coderabbitai review |
|
@seanbudd, I will review the changes now. Actions PerformedReview triggered.
|
WalkthroughThe recent updates enhance NVDA's interaction with the Windows 11 emoji panel and clipboard history by introducing the Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (2)
source/appModules/windowsinternal_composableshell_experiences_textinput_inputapp.py (2)
Line range hint
84-84: Undefined name_.The
_function is used for translations but is not defined or imported in this file. Ensure it is imported or defined.+ from gettext import gettext as _
Line range hint
229-229: Undefined name_.The
_function is used for translations but is not defined or imported in this file. Ensure it is imported or defined.+ from gettext import gettext as _
user_docs/en/changes.md
Outdated
| * In emoji panel, NVDA will no longer appear to get stuck when closing clipboard history and emoji panel. (#16346, #16347, @josephsl) | ||
| * NVDA will once again announce visible candidates when opening Windows 11 IME interface. (#14023, @josephsl) | ||
| * NVDA will no longer announce "clipboard history" twice when reviewing emoji panel navigation menu items. (#16532, @josephsl) | ||
| * NVDA will no longer cut off speech and braille while reviewing kaomojis and symbols in emoji panel. (#16533, @josephsl) |
There was a problem hiding this comment.
Ensure clarity and consistency in documentation.
The documentation changes accurately reflect the improvements and fixes mentioned in the PR summary. However, consider rephrasing for better clarity and consistency:
- * In emoji panel, NVDA will no longer appear to get stuck when closing clipboard history and emoji panel. (#16346, #16347, @josephsl)
+ * NVDA will no longer get stuck when closing the clipboard history and emoji panel in Windows 11. (#16346, #16347, @josephsl)
- * NVDA will once again announce visible candidates when opening Windows 11 IME interface. (#14023, @josephsl)
+ * NVDA will announce visible candidates again when opening the Windows 11 IME interface. (#14023, @josephsl)
- * NVDA will no longer announce "clipboard history" twice when reviewing emoji panel navigation menu items. (#16532, @josephsl)
+ * NVDA will no longer announce "clipboard history" twice when navigating through the emoji panel menu items. (#16532, @josephsl)
- * NVDA will no longer cut off speech and braille while reviewing kaomojis and symbols in emoji panel. (#16533, @josephsl)
+ * NVDA will no longer cut off speech and braille when reviewing kaomojis and symbols in the emoji panel. (#16533, @josephsl)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * In emoji panel, NVDA will no longer appear to get stuck when closing clipboard history and emoji panel. (#16346, #16347, @josephsl) | |
| * NVDA will once again announce visible candidates when opening Windows 11 IME interface. (#14023, @josephsl) | |
| * NVDA will no longer announce "clipboard history" twice when reviewing emoji panel navigation menu items. (#16532, @josephsl) | |
| * NVDA will no longer cut off speech and braille while reviewing kaomojis and symbols in emoji panel. (#16533, @josephsl) | |
| * NVDA will no longer get stuck when closing the clipboard history and emoji panel in Windows 11. (#16346, #16347, @josephsl) | |
| * NVDA will announce visible candidates again when opening the Windows 11 IME interface. (#14023, @josephsl) | |
| * NVDA will no longer announce "clipboard history" twice when navigating through the emoji panel menu items. (#16532, @josephsl) | |
| * NVDA will no longer cut off speech and braille when reviewing kaomojis and symbols in the emoji panel. (#16533, @josephsl) |
There was a problem hiding this comment.
these suggestions look good to me, except perhaps the first one? The first one appears to be changing meaning
There was a problem hiding this comment.
@seanbudd, thank you for your feedback. Upon reviewing the first suggestion, I agree that it might change the meaning slightly. The original text emphasizes that NVDA appears to get stuck, while the suggested change implies that it definitively gets stuck. To maintain the original intent, we can rephrase it for clarity without altering the meaning:
- * In emoji panel, NVDA will no longer appear to get stuck when closing clipboard history and emoji panel. (#16346, #16347, @josephsl)
+ * NVDA will no longer appear to get stuck when closing the clipboard history and emoji panel in Windows 11. (#16346, #16347, @josephsl)Would you like me to proceed with this revision?
New Learnings Added
User: seanbudd
PR: nvaccess/nvda#16555
File: user_docs/en/changes.md:27-30
Timestamp: 2024-05-16T01:53:50.659Z
Learning: When suggesting documentation changes, ensure that the rephrased text does not alter the original meaning, especially when the original text includes qualifiers like "appear to."
Note: Learnings are effective only in the context of specific code segments. To apply general coding guidelines, please configure review instructions.
There was a problem hiding this comment.
Note to NV Access and the community: the conversations I'm having with Code Rabbit is not meant for human consumption but feel free to look at it (it also shows how I'm approaching the bot as a software engineer and a grad student/researcher interested in communication and tech):
I see. Two things:
- Not all members of the project are trained in technical communication (I am schooled in it), and for many, English is not our first language (me included). So issues on clarity is acceptable (we have a staff member at NV Access who can go over grammar and other issues later).
- Look at the unindented line which says "Windows 11 fixes", so there is no need to repeat this in indented lines.
I know you are using sophisticated networks to analyze suggestions based on whatever software development data (philosophy, experiences, documentation, and what not). Do remember his though: whatever was set by the organization (including its discourse and mindset) can and do override commonly held ideas represented by the data you are using. At least, for the first try, you got it right.
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
source/appModules/windowsinternal_composableshell_experiences_textinput_inputapp.py
Show resolved
Hide resolved
|
Hi, thanks for the status on this – I’ll respond to that bot and do some scholarly research (perhaps a good case study I can unpack tonight my time). Thanks.
|
|
Hi all, I'll incorporate both human and machine generated suggestions for the changelog. A few thoughts:
Two implications:
Layman summary: the bot is useful, but have a critical mindset when interacting with it. Thanks. |
Link to issue number:
Closes #16346
Closes #16532
Closes #16533
Follow-up to #16347
Summary of the issue:
NVDA cuts off speech, repeats items, and does not report system focus upon closing emji panel when handling element selected event in Windows 11 emoji panel's navigation menu items.
Description of user facing changes
NVDA will:
Description of development approach
A dedicated overlay class was added for Windows 11 emoji panel navigation menu items along with UIA element selected event for them that does the following:
Testing strategy:
Manual testing: see #16346, #16532, and #16533. Specifically, test to make sure that NVDA is no longer announcing "clipboard history" twice while navigating parts of the emoji panel and speech is no longer cut off while reviewing kaomojis and symbols.
Known issues with pull request:
This PR may not cover all the cases of element selected event mishap, but it covers most noticeable cases.
Code Review Checklist:
Summary by CodeRabbit
New Features
NavigationMenuItemfor better navigation in the Windows 11 emoji panel.Bug Fixes