Skip to content

Port UWP beep toggle setting from upstream (serrebidev) #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ragb merged 3 commits into from
Aug 24, 2026
Merged

Port UWP beep toggle setting from upstream (serrebidev) #6

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fdbf75d
Add a setting to toggle the UWP review alert beeps
ragb Aug 24, 2026
aa804a1
Add trailing comma required by the add-trailing-comma hook
ragb Aug 24, 2026
b204993
Call super().terminate() when unregistering the settings panel
ragb Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions addon/globalPlugins/virtualRevision.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
import ui
import scriptHandler
import addonHandler
import config
import gui
import wx
from gui import guiHelper, settingsDialogs

addonHandler.initTranslation()

Expand Down Expand Up @@ -76,6 +80,27 @@ def _cleanTerminalText(text):
return "\n".join(lines)


config.conf.spec["virtualRevision"] = {
"playBeep": "boolean(default=True)",
}


class VirtualRevisionSettingsPanel(settingsDialogs.SettingsPanel):
# Translators: Title of the Virtual Revision settings panel.
title = _("Virtual Revision")

def makeSettings(self, settingsSizer):
sHelper = guiHelper.BoxSizerHelper(self, sizer=settingsSizer)
# Translators: Label for the checkbox that toggles the alert beeps for UWP windows.
self.playBeepCheckBox = sHelper.addItem(
wx.CheckBox(self, label=_("Play alert &beeps when reviewing UWP windows")),
)
self.playBeepCheckBox.SetValue(config.conf["virtualRevision"]["playBeep"])

def onSave(self):
config.conf["virtualRevision"]["playBeep"] = self.playBeepCheckBox.GetValue()


def obtainUWPWindowText():
foreground = api.getForegroundObject()
desktop = api.getDesktopObject()
Expand Down Expand Up @@ -119,6 +144,18 @@ def obtainUWPWindowText():
class GlobalPlugin(globalPluginHandler.GlobalPlugin):
scriptCategory = SCRCAT_TEXTREVIEW

def __init__(self):
super().__init__()
if not globalVars.appArgs.secure:
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.append(VirtualRevisionSettingsPanel)

def terminate(self):
super().terminate()
try:
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.remove(VirtualRevisionSettingsPanel)
except ValueError:
pass

@scriptHandler.script(
# Translators: Message presented in input help mode.
description=_("Opens a window containing the text of the currently focused window for easy review."),
Expand All @@ -143,11 +180,14 @@ def script_virtualWindowReview(self, gesture):
text = _cleanTerminalText(info.clipboardText)
# Because it may take a while to iterate through elements, play abeep to alert users of this fact and the fact it's a UWP screen.
elif obj.windowClassName.startswith(("Windows.UI.Core", "Windows.UI.Input.InputSite")):
import tones
playBeep = config.conf["virtualRevision"]["playBeep"]
if playBeep:
import tones

tones.beep(400, 300)
tones.beep(400, 300)
text = "\n".join(obtainUWPWindowText())
tones.beep(400, 50)
if playBeep:
tones.beep(400, 50)
else:
root = None
for ancestor in api.getFocusAncestors():
Expand Down