Skip to content

UIA notification event handler: NotificationKind -> notificationKind, NotificationProcessing -> notificationProcessing (argument name consistency)#18319

Merged
seanbudd merged 3 commits into
nvaccess:masterfrom
josephsl:i18220followupNotificationEventArgumentNames
Jun 25, 2025
Merged

Conversation

@josephsl

Copy link
Copy Markdown
Contributor

Quick follow-up to #18229:

Link to issue number:

None

Summary of the issue:

UIA notification argument names are inconsistent across UIA handler, app modules, and UIA NVDA objects.

Description of user facing changes:

None

Description of developer facing changes:

None, as the app module API was just merged.

Description of development approach:

Change the follwoing argument names in app module version of shouldProcessUIANotificationEvent:

  • NotificationKind -> notificationKind
  • NotificationProcessing -> notificationProcessing

Testing strategy:

Manual: make sure UIA notifications such as volume changes and window style changes are announced.

Known issues with pull request:

We may need to revisit UIA handler notification event handler argument names in 2026.1 dev cycle - this PR attempts to correct part of the inconsistency issue, with the event handler change proposed for 2026.1.

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.

@coderabbitai summary

josephsl added 2 commits June 24, 2025 07:52
…nProcessing -> notificationProcessing (argumetn name/resolving TypeError)
…ficationKind, NotificationProcessing -> notificationProcessing (argument name consistency with UIA object version)
@josephsl josephsl requested a review from a team as a code owner June 24, 2025 15:27
@josephsl josephsl requested a review from seanbudd June 24, 2025 15:27
@josephsl

Copy link
Copy Markdown
Contributor Author

NOte: this PR replaces #18317.

@SaschaCowley SaschaCowley added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jun 24, 2025
@seanbudd

Copy link
Copy Markdown
Member

pre-commit.ci run

@seanbudd

Copy link
Copy Markdown
Member

@josephsl - please fix up pre-commit failures

… with correctly spelled argument names (cauht with Ruff)
@seanbudd seanbudd merged commit e277bad into nvaccess:master Jun 25, 2025
17 checks passed
@github-actions github-actions Bot added this to the 2025.2 milestone Jun 25, 2025
@josephsl josephsl deleted the i18220followupNotificationEventArgumentNames branch June 25, 2025 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants