Convert to new key; feature broken in Word (UIA or legacy)

SaschaCowley · Sep 5, 2025 · Apr 18, 2025 · Apr 22, 2025 · Apr 22, 2025 · Apr 23, 2025
commit 5696410772c385777c220f7edfebef2bd78c5c59
@@ -30,6 +30,7 @@
 import controlTypes
 from controlTypes import TextPosition, TextAlign
 import config
+from config.configFlags import ReportSpellingErrors
 import speech
 import api
 import textInfos
@@ -313,7 +314,7 @@ def _getFormatFieldAnnotationTypes(
 		# Always mutate to a tuple to allow for a generic x in y matching
 		if not isinstance(annotationTypes, tuple):
 			annotationTypes = (annotationTypes,)
-		if formatConfig["reportSpellingErrors"]:
+		if formatConfig["reportSpellingErrors2"] != ReportSpellingErrors.OFF.value:
 			if UIAHandler.AnnotationType_SpellingError in annotationTypes:
 				formatField["invalid-spelling"] = True
 			if UIAHandler.AnnotationType_GrammarError in annotationTypes:
@@ -368,7 +369,7 @@ def _getFormatFieldAtRange(  # noqa: C901
 		if not isinstance(textRange, UIAHandler.IUIAutomationTextRange):
 			raise ValueError("%s is not a text range" % textRange)
 		fetchAnnotationTypes = (
-			formatConfig["reportSpellingErrors"]
+			formatConfig["reportSpellingErrors2"] != ReportSpellingErrors.OFF.value
 			or formatConfig["reportComments"]
 			or formatConfig["reportRevisions"]
 			or formatConfig["reportBookmarks"]

@@ -2,7 +2,7 @@
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
 # Copyright (C) 2006-2025 NV Access Limited, Peter Vágner, Joseph Lee, Bill Dengler,
-# Burman's Computer and Education Ltd, Cary-rowen
+# Burman's Computer and Education Ltd, Cary-rowen, Cyrille Bougot
 
 """Mix-in classes which provide common behaviour for particular types of controls across different APIs.
 Behaviors described in this mix-in include providing table navigation commands for certain table rows, terminal input and output support, announcing notifications and suggestion items and so on.
@@ -297,7 +297,7 @@ def _delayedDetection():
 
 	def event_typedCharacter(self, ch: str):
 		if (
-			config.conf["documentFormatting"]["reportSpellingErrors"]
+			config.conf["documentFormatting"]["reportSpellingErrors2"]
 			and config.conf["keyboard"]["alertForSpellingErrors"]
 			and (
 				# Not alpha, apostrophe or control.

@@ -196,13 +196,13 @@ class ReportSpellingErrors(DisplayStringIntEnum):
 	def _displayStringLabels(self):
 		return {
 			# Translators: A choice in a combo box in the document formatting dialog to not report spelling errors.
-			ReportSpellingErrors.OFF: pgettext("line indentation setting", "Off"),
+			ReportSpellingErrors.OFF: pgettext("reportSpellingErrorsSetting", "Off"),
 			# Translators: A choice in a combo box in the document formatting dialog to report spelling errors
 			# with Speech.
-			ReportSpellingErrors.SPEECH: pgettext("line indentation setting", "Speech"),
+			ReportSpellingErrors.SPEECH: pgettext("reportSpellingErrorsSetting", "Speech"),
 			# Translators: A choice in a combo box in the document formatting dialog to report spelling errors
 			# with a sound.
-			ReportSpellingErrors.SOUND: pgettext("line indentation setting", "Sound"),
+			ReportSpellingErrors.SOUND: pgettext("reportSpellingErrorsSetting", "Sound"),
 		}
 
 

@@ -227,7 +227,7 @@
 	reportLineSpacing = boolean(default=false)
 	reportStyle = boolean(default=false)
 	# 0: Off, 1: Speech, 2: Sound
-	reportSpellingErrors = integer(min=0, max=2, default=1)
+	reportSpellingErrors2 = integer(min=0, max=2, default=1)
 	reportPage = boolean(default=true)
 	reportLineNumber = boolean(default=False)
 	# 0: Off, 1: Speech, 2: Tones, 3: Both Speech and Tones

@@ -584,18 +584,19 @@ def upgradeConfigFrom_17_to_18(profile: ConfigObj):
 
 	section = "documentFormatting"
 	key = "reportSpellingErrors"
+	newKey = "reportSpellingErrors2"
 	try:
 		oldValue: bool = profile[section].as_bool(key)
 	except KeyError:
 		log.debug(f"'{key}' not present in config, no action taken.")
 		return
 	except ValueError:
-		log.error(f"'{key}' is not a boolean, got {profile[section][key]!r}. Deleting.")
-		del profile[section][key]
+		log.error(f"'{key}' is not a boolean, got {profile[section][key]!r}. No action taken.")
 		return
-	else:
-		newValue = ReportSpellingErrors.SPEECH.value if oldValue else ReportSpellingErrors.OFF.value
-		profile[section][key] = newValue
-		log.debug(
-			f"Converted '{key}' from {oldValue!r} to {newValue} ({ReportSpellingErrors(newValue).name}).",
-		)
+
+	del profile[section][key]
+	newValue = ReportSpellingErrors.SPEECH.value if oldValue else ReportSpellingErrors.OFF.value
+	profile[section][newKey] = newValue
+	log.debug(
+		f"Converted '{key}' from {oldValue!r} to {newValue} ({ReportSpellingErrors(newValue).name}).",
+	)
@@ -802,7 +802,7 @@ def script_toggleReportStyle(self, gesture):
 	def script_toggleReportSpellingErrors(self, gesture):
 		toggleIntegerValue(
 			configSection="documentFormatting",
-			configKey="reportSpellingErrors",
+			configKey="reportSpellingErrors2",
 			enumClass=ReportSpellingErrors,
 			# Translators: Reported when the user cycles through the choices to report spelling errors.
 			# {mode} will be replaced with the mode; e.g. Off, Speech, Sound.
@@ -2539,7 +2539,7 @@ def _reportFormattingHelper(self, info, browseable=False):
 			"reportColor",
 			"reportStyle",
 			"reportAlignment",
-			"reportSpellingErrors",
+			"reportSpellingErrors2",
 			"reportLineIndentation",
 			"reportParagraphIndentation",
 			"reportLineSpacing",

@@ -2118,7 +2118,7 @@ def makeSettings(self, settingsSizer):
 		)
 		self.bindHelpEvent("KeyboardSettingsAlertForSpellingErrors", self.alertForSpellingErrorsCheckBox)
 		self.alertForSpellingErrorsCheckBox.SetValue(config.conf["keyboard"]["alertForSpellingErrors"])
-		if not config.conf["documentFormatting"]["reportSpellingErrors"]:
+		if config.conf["documentFormatting"]["reportSpellingErrors2"] == ReportSpellingErrors.DISABLE.value:
 			self.alertForSpellingErrorsCheckBox.Disable()
 
 		# Translators: This is the label for a checkbox in the
@@ -2805,7 +2805,7 @@ def makeSettings(self, settingsSizer):
 			"reportSpellingErrors",
 			self.spellingErrorsCombo,
 		)
-		self.spellingErrorsCombo.SetSelection(config.conf["documentFormatting"]["reportSpellingErrors"])
+		self.spellingErrorsCombo.SetSelection(config.conf["documentFormatting"]["reportSpellingErrors2"])
 
 		# Translators: This is the label for a group of document formatting options in the
 		# document formatting settings panel
@@ -3028,7 +3028,7 @@ def onSave(self):
 		config.conf["documentFormatting"]["reportHighlight"] = self.highlightCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportAlignment"] = self.alignmentCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportStyle"] = self.styleCheckBox.IsChecked()
-		config.conf["documentFormatting"]["reportSpellingErrors"] = self.spellingErrorsCombo.GetSelection()
+		config.conf["documentFormatting"]["reportSpellingErrors2"] = self.spellingErrorsCombo.GetSelection()
 		config.conf["documentFormatting"]["reportPage"] = self.pageCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLineNumber"] = self.lineNumberCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLineIndentation"] = self.lineIndentationCombo.GetSelection()

@@ -1516,7 +1516,7 @@ def getTextInfoSpeech(  # noqa: C901
 	)
 	# For performance reasons, when navigating by paragraph or table cell, spelling errors will not be announced.
 	if unit in (textInfos.UNIT_PARAGRAPH, textInfos.UNIT_CELL) and reason == OutputReason.CARET:
-		formatConfig["reportSpellingErrors"] = ReportSpellingErrors.OFF.value
+		formatConfig["reportSpellingErrors2"] = ReportSpellingErrors.OFF.value
 
 	# Fetch the last controlFieldStack, or make a blank one
 	controlFieldStackCache = speakTextInfoState.controlFieldStackCache if speakTextInfoState else []
@@ -2993,12 +2993,12 @@ def getFormatFieldSpeech(  # noqa: C901
 				# Translators: Reported when text no longer contains a bookmark
 				text = _("out of bookmark")
 				textList.append(text)
-	if formatConfig["reportSpellingErrors"] != ReportSpellingErrors.OFF.value:
+	if formatConfig["reportSpellingErrors2"] != ReportSpellingErrors.OFF.value:
 		invalidSpelling = attrs.get("invalid-spelling")
 		oldInvalidSpelling = attrsCache.get("invalid-spelling") if attrsCache is not None else None
 		if (invalidSpelling or oldInvalidSpelling is not None) and invalidSpelling != oldInvalidSpelling:
 			if invalidSpelling:
-				if formatConfig["reportSpellingErrors"] == ReportSpellingErrors.SPEECH.value:
+				if formatConfig["reportSpellingErrors2"] == ReportSpellingErrors.SPEECH.value:
 					# Translators: Reported when text contains a spelling error.
 					text = _("spelling error")
 				else:

@@ -6,7 +6,7 @@
 
 ### New Features
 
-* While reading text, spelling errors can now be reported with a sound. (#4233, @jcsteh, @CyrilleB79)
+* While reading text, spelling errors can now be reported with a sound instead of speech. (#4233, @jcsteh, @CyrilleB79)
 
 ### Changes