Message Dialog API take 2 by SaschaCowley · Pull Request #17582 · nvaccess/nvda

SaschaCowley · 2025-01-06T00:42:58Z

Link to issue number:

Closes #13007
Closes #12344
Closes #12353

Summary of the issue:

This is the second PR to merge the message dialog API into NVDA. The previous merge was at f437723.
See #17304 for full implementation details.
The original PR was reverted by #17561, due to #17553 and #17560.

Description of user facing changes

This PR does not, in itself, introduce any end-user facing changes. However, it lays the groundwork for closing a number of issues.

Tasks

Fix the COM registration fixing tool (It seems that the registration tool is not working. #17560)
Fix NVDA updates (cannot update to current alpha #17553)

Description of development approach

Restored gui.nvdaControls.MessageDialog inheriting from ContextHelpMixin, which was accidentally lost.

Changed updateCheck.UpdateAskInstallDialog.onUpdateButton and onPostponeButton to simply end the modal, returning the appropriate code. Added a static method to UpdateAskInstallDialog which returns a callback function which, when given the return code from UpdateAskInstallDialog, performs the appropriate action. Added a property method to generate this callback function given the attributes of the instance on which it is called.

Testing strategy:

Created a portable copy of NVDA (scons dist), and tested running the CRFT:

Running and granting permission - works as expected
Running and denying permission - works as expected
Cancelling - works as expected

Added updateVersionType="snapshot:alpha" to source/versionInfo.py`, and tested updating with NVDA running from source:

Attempt updating via NVDA menu -> Help -> Check for update... -> Download update -> Update - works as expected
Update by downloading then postponing update, then exit NVDA -> Install pending update
1. Without incompatible updates installed - works as expected
2. With incompatible updates installed - works as expected
Update by downloading then postponing update, restarting NVDA, then NVDA menu -> Install pending update - works as expected
Update by downloading then postponing update, restarting NVDA, then accepting the prompt to install the update - works as expected

Known issues with pull request:

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

…draft spec

…logButton` if provided

… rather than normal functions.

…eDialogApi

Co-authored-by: Sean Budd <sean@nvaccess.org>

# Conflicts: # user_docs/en/changes.md

…button press, but to have a callback property which is a callable suitable for passing to `runScriptModalDialog`.

seanbudd

New changes look good

seanbudd · 2025-01-10T03:22:58Z

Can you announce the API breaking changes on the mailing list? I think they were missed

…e NVDA Menu (#18070) Closes #17947 Supersedes #17991 Summary of the issue: When executing some Remote Access actions via the Remote Access submenu in the NVDA menu, the status is interrupted by the focus changing, making the messages useless. Description of user facing changes Remote Access actions performed via the NVDA menu should now correctly report their status. Description of development approach - Add a `delayedMessage` function to `ui`, based on the approach taken for focusing open blocking modals in #17582. - Remove the now duplicated code, and replace it with a call to `ui.delayedMessage`. - In `_remoteClient.client.RemoteClient`, updated `copyLink`, `pushClipboard`, and `toggleMute`, to use `ui.delayedMessage` instead of `ui.message`, as these methods can be envoked directly from the menu. - Also moved the success message out of `globalCommands.GlobalCommands.script_copyRemoteLink` into `_remoteClient.client.RemoteClient.copyLink`. - Updated `_remoteClient.cues._playCue` to use `ui.delayedMessage` instead of `ui.message`, as the "Disconnect" menu item causes a cue to be issued. This means that cues should work even if issued at the same time as a UI change, and should have very little performance impact. Testing strategy: - Performed the above listed commands with and without a Remote Access session in progress.

SaschaCowley added 30 commits September 18, 2024 17:16

Working refactored message dialog based on extant message dialog and …

dfdd299

…draft spec

Improve positioning

38c99cb

Explicitly focus default item

07ba293

Improved types and type hints

a479a4f

Switched to setLabelText to avoid mnemonic issue

3326a98

Switched to icon bundles

1a8f82f

Renamed private methods to be dunder

99dd605

Some manual test cases

2a3df49

Added check for default item before focusing

947f669

Minor changes to make temp code work better

6bd8c8a

Implementation of addButton, addOkButton and addCancelButton

2e255cb

Return self for chaining, and add a option to set as default

ce826f2

Added close functionality

9a7dbf8

Fixed layout issues and updated test case

768e052

Added post popup call

7e6754f

Added infrastructure for updates to API not yet implemented

601a193

Merge branch 'master' into messageDialogApi

64801d9

Swiutch to using partials for callback calling

a44063d

Added translator comments and some docstrings

3e5b03c

Added type checking to __call_callback

e7e1d29

Made addButton a singledispatchmethod that will add a `MessageDia…

08360fd

…logButton` if provided

Refactored addOkButton and addCancelButton to be partialmethods…

917d8e4

… rather than normal functions.

Added multi button add method

273d771

Documentation improvements

8f1bcba

Added deque to track open MessageDialog instances

5e9d4c5

Refactored to use a registry oif callbacks

f8cde12

Added adders for oother default button types

ac2be85

Added custom button IDs

bcc49f9

Various code clean-ups

1a95e06

Partially working modal dialogs

5ec943e

SaschaCowley and others added 14 commits December 13, 2024 11:09

Corrects to dev guide

fcafc8a

Corrections to dev guide

0c7a6c7

Merge branch 'i13007' of https://github.com/nvaccess/nvda into messag…

65ced3c

…eDialogApi

Apply suggestions from code review

8b02b72

Co-authored-by: Sean Budd <sean@nvaccess.org>

Made several parameterized argument lists namedtuples for readability

0dce0e9

Merge branch 'master' into messageDialogApi

0c99151

# Conflicts: # user_docs/en/changes.md

Fixed up admonissions

f52a07e

Added notes on thread safety

f437723

Restore MessageDialog inheriting from ContextHelpMixin

ba88884

Merge branch 'master' into messageDialogApi2

374dc7e

Slightly refactor UpdateAskInstallDialog not to take any action on …

3893564

…button press, but to have a callback property which is a callable suitable for passing to `runScriptModalDialog`.

Documentation

28931c2

Updated other instances to use new call style

20a56db

Update changes

ae893e4

SaschaCowley marked this pull request as ready for review January 6, 2025 04:43

SaschaCowley requested a review from a team as a code owner January 6, 2025 04:43

SaschaCowley requested a review from seanbudd January 6, 2025 04:43

seanbudd approved these changes Jan 6, 2025

View reviewed changes

Comment thread source/updateCheck.py Outdated

SaschaCowley commented Jan 6, 2025

View reviewed changes

Comment thread source/updateCheck.py Outdated

Update source/updateCheck.py

0a25805

SaschaCowley added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jan 6, 2025

SaschaCowley merged commit bd45d8e into master Jan 8, 2025

SaschaCowley deleted the messageDialogApi branch January 8, 2025 03:55

github-actions Bot added this to the 2025.1 milestone Jan 8, 2025

LeonarddeR mentioned this pull request Apr 9, 2025

NVDA Alpha sometimes fails to restart after add-on install #17925

Closed

nishimotz mentioned this pull request Apr 14, 2025

2025.1 本家の翻訳 nvdajp/nvdajp#498

Closed

SaschaCowley mentioned this pull request May 8, 2025

Do not interrupt Remote Access status messages when executing from the NVDA Menu #18070

Merged

5 tasks

Adriani90 mentioned this pull request Jun 25, 2025

Improve accessibility of some controls used in nvda #6455

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Message Dialog API take 2#17582

Message Dialog API take 2#17582
SaschaCowley merged 221 commits into
masterfrom
messageDialogApi

SaschaCowley commented Jan 6, 2025 •

edited

Loading

Uh oh!

seanbudd left a comment

Uh oh!

Uh oh!

Uh oh!

seanbudd commented Jan 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

SaschaCowley commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link to issue number:

Summary of the issue:

Description of user facing changes

Tasks

Description of development approach

Testing strategy:

Known issues with pull request:

Code Review Checklist:

Uh oh!

seanbudd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

seanbudd commented Jan 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

SaschaCowley commented Jan 6, 2025 •

edited

Loading