Enable caret event detection for IA2Web

[LeonarddeR]

CC @jcsteh

Link to issue number:

Fixes #11545

Summary of the issue:

We do not rely on caret events for IA2.

Description of user facing changes

Possibly slightly faster caret navigation in Firefox and Chrome.

Description of development approach

1. No longer ignore caret events for IA2Web objects
2. Ignore the location change and show events for IA2, rather, rely on IA2_EVENT_TEXT_CARET_MOVED

Testing strategy:

Verified that IA2_EVENT_TEXT_CARET_MOVED is fired for:

• Firefox
• Chrome
• LibreOffice

Known issues with pull request:

None known

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• Bug Fixes

  • Improved handling of caret events for IAccessible2 objects to enhance accessibility features.

• Documentation

  • Updated documentation to reflect the reliance on events for caret movement in various scenarios, including UIA for XAML and WPF text controls, and IAccessible2 for browsers like Firefox and Chromium.

• Refactor

  • Removed the caretMovementDetectionUsesEvents attribute from the Ia2Web class to streamline code related to caret movement detection.

[coderabbitai]

Walkthrough

The recent changes focus on improving NVDA's handling of caret movement events, particularly for browsers like Firefox and Chromium. The IAccessibleHandler now distinguishes IA2 events correctly, and the Ia2Web class in NVDAObjects no longer uses an attribute for caret event detection. These updates aim to enhance performance and accuracy in caret positioning, addressing issues of lag and misreported positions.

Changes

Files/Modules	Change Summary
source/IAccessibleHandler/__init__.py	Added a conditional block to handle cases where focus.IAccessibleObject is an instance of IA2.IAccessible2, logging MSAA caret events and returning False.
source/NVDAObjects/IAccessible/ia2Web.py	Removed the attribute caretMovementDetectionUsesEvents from the Ia2Web class.
user_docs/en/changes.md	Updated to reflect that NVDA now relies on events for caret movement in various scenarios, including UIA for XAML/WPF text controls and IAccessible2 for browsers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NVDA
    participant Browser
    participant IAccessible2

    User->>Browser: Move caret (e.g., arrow keys)
    Browser->>IAccessible2: IA2_EVENT_TEXT_CARET_MOVED event
    IAccessible2->>NVDA: Send caret moved event
    NVDA->>IAccessibleHandler: Process caret event
    IAccessibleHandler->>NVDA: Update caret position
    NVDA->>User: Provide feedback on caret position

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Rely on IA2 caret events for Chrome and Firefox editors (#11545)	✅
No longer treat location change events as caret events (#11545)	✅
Update documentation to reflect the reliance on events (#11545)	✅

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.