Skip to content

Persist magnifier starting#20051

Merged
seanbudd merged 15 commits into
betafrom
persistMagnifierStart
May 15, 2026
Merged

Persist magnifier starting#20051
seanbudd merged 15 commits into
betafrom
persistMagnifierStart

Conversation

@seanbudd
Copy link
Copy Markdown
Member

@seanbudd seanbudd commented May 4, 2026

Link to issue number:

Fixes #19494

Summary of the issue:

Whether or not the magnifier has already started was not persisted in config

Description of user facing changes:

magnifier being enabled is now persisted in config

fixed some collisions with accelerator keys in the magnifier settings dialog

Description of developer facing changes:

none

Description of development approach:

added code to toggle magnifier and persist in settings

Testing strategy:

manual testing

Known issues with pull request:

none

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.

@seanbudd seanbudd marked this pull request as ready for review May 4, 2026 06:39
@seanbudd seanbudd requested a review from a team as a code owner May 4, 2026 06:39
Copilot AI review requested due to automatic review settings May 4, 2026 06:39
@seanbudd seanbudd requested a review from a team as a code owner May 4, 2026 06:39
@seanbudd seanbudd marked this pull request as draft May 4, 2026 06:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to persist NVDA’s Magnifier enabled/disabled state in configuration, expose an “Enable magnifier” checkbox in the Magnifier settings panel (with immediate effect), and adjust some dialog accelerator keys to avoid conflicts.

Changes:

  • Add magnifier.enabled to the config spec and implement getEnabled/setEnabled helpers.
  • Update magnifier toggle command to persist enabled state.
  • Add an “Enable magnifier (immediate effect)” checkbox to the Magnifier settings panel and update User Guide documentation.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
user_docs/en/userGuide.md Documents new Magnifier enable setting in the User Guide.
source/gui/settingsDialogs.py Adds enable/disable checkbox to the Magnifier settings panel and adjusts accelerator keys.
source/config/configSpec.py Introduces persisted magnifier.enabled setting.
source/_magnifier/config.py Adds config accessors for magnifier enabled state.
source/_magnifier/commands.py Persists enabled state when toggling magnifier.

Comment thread source/config/configSpec.py
Comment thread source/_magnifier/config.py Outdated
Comment thread source/_magnifier/commands.py
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/_magnifier/commands.py Outdated
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 4, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Comment thread source/_magnifier/__init__.py
Comment thread source/_magnifier/__init__.py
Comment thread source/core.py
Comment thread source/gui/settingsDialogs.py
Comment thread source/gui/settingsDialogs.py
Comment thread user_docs/en/userGuide.md Outdated
Comment on lines +16 to +31
def setEnabled(enable: bool) -> None:
"""
Set the config for the magnifier state (enable or disabled).

:param enable: True if the magnifier is enabled, False if it is disabled.
"""
config.conf["magnifier"]["enabled"] = enable


def getEnabled() -> bool:
"""
Check if the magnifier is enabled in config.

:return: True if the magnifier is enabled, False otherwise.
"""
return config.conf["magnifier"]["enabled"]
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that's necessary

@seanbudd seanbudd added this to the 2026.2 milestone May 11, 2026
@seanbudd seanbudd changed the base branch from master to beta May 11, 2026 08:20
@seanbudd seanbudd changed the base branch from beta to master May 11, 2026 09:32
@seanbudd seanbudd changed the base branch from master to beta May 11, 2026 09:33
@seanbudd seanbudd mentioned this pull request May 12, 2026
5 tasks
@seanbudd seanbudd marked this pull request as ready for review May 12, 2026 02:52
@seanbudd seanbudd marked this pull request as draft May 12, 2026 23:21
Comment thread source/gui/settingsDialogs.py Outdated
Comment thread source/gui/settingsDialogs.py Outdated
seanbudd and others added 2 commits May 15, 2026 14:37
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
Comment thread user_docs/en/userGuide.md Outdated
Comment thread user_docs/en/userGuide.md Outdated
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
Copy link
Copy Markdown
Member

@Qchristensen Qchristensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@seanbudd seanbudd merged commit 7bf0d9a into beta May 15, 2026
37 of 39 checks passed
@seanbudd seanbudd deleted the persistMagnifierStart branch May 15, 2026 08:40
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.

Store whether Magnifier is enabled in the config

4 participants