Add ability to report the document layout in Microsoft Word

source/appModules/winword.py

@@ -8,8 +8,12 @@
 Microsoft Word only.
 """
 
+import api
 import appModuleHandler
-from scriptHandler import script
+import controlTypes
+import globalCommands
+import speech
+from scriptHandler import script, getLastScriptRepeatCount
 import ui
 from NVDAObjects.IAccessible.winword import WordDocument as IAccessibleWordDocument
 from NVDAObjects.UIA.wordDocument import WordDocument as UIAWordDocument
@@ -21,6 +25,33 @@ def chooseNVDAObjectOverlayClasses(self, obj, clsList):
 		if UIAWordDocument in clsList or IAccessibleWordDocument in clsList:
 			clsList.insert(0, WinwordWordDocument)
 
+	@script(
+		category=globalCommands.SCRCAT_FOCUS,
+		description=_(
+			# Translators: Input help mode message for report title bar command in Microsoft Word.
+			"In Microsoft Word, reports the title and the layout of the current document. If pressed twice, spells this information. If pressed three times, copies it to the clipboard",
+		),
+		gesture="kb:NVDA+t",
+		speakOnDemand=True,
+	)
+	def script_title(self, gesture):
+		title = api.getForegroundObject().name
+		statusBar = api.getStatusBar()
+		if statusBar is not None:
+			for child in statusBar.children:
+				if controlTypes.state.State.PRESSED in child.states:
+					documentLayout = child.name
+					foregroundWindowName = title
+					title = f"{foregroundWindowName} - {documentLayout}"
+					break
+		repeatCount = getLastScriptRepeatCount()
+		if repeatCount == 0:
+			ui.message(title)
+		elif repeatCount == 1:
+			speech.speakSpelling(title)
+		else:
+			api.copyToClip(title, notify=True)
+
 
 class WinwordWordDocument(WordDocument):
 	@script(gesture="kb:control+shift+e")

user_docs/en/changes.md

@@ -35,6 +35,7 @@ To use this feature, "allow NVDA to control the volume of other applications" mu
   * It will now show a message to the user, including the error, in the rare event of a Windows error while attempting COM re-registrations.
 * In Word and Outlook the result of more font formatting shortcuts is now reported. (#10271, @CyrilleB79)
 * Default input and output braille tables will now be determined based on the NVDA language. (#16390, #290, @nvdaes)
+* In Microsoft Word, when using the `report title bar` command, the document layout will be announced if this information is available on the status bar (#15088, @nvdaes)
 
 ### Bug Fixes