Sleeping Object Focus Gain Indicator

[cdw108]

I am looking into implementing an indication (beeps or speech) for when an object that is in sleep mode gains focus from another object (this idea was found from a posted issue), and I am curious to know if there is a good way to detect a change in focus between objects. Along with this, is there any way to play a sound while focused on an object currently in sleep mode besides the script attribute "allowInSleepMode" as I want to implement this without a new gesture command if possible.

Currently my idea is to write a global plugin with a "event_gainFocus" function that checks for an object's sleep status, then produces a beep when that object regains focus, but I am lost as to how to read that focus change. Thank you in advance.

[seanbudd]

Can you share what issue this is from? It will help provide context

[cdw108]

Yes of course, sorry for the confusion. This is the issue that I originally looked at.

[seanbudd]

I don't think your proposal solves #13532.
That issue requests a notification when sleep mode gets activated by switching tabs, not a gesture to check after. script_toggleCurrentAppSleepMode effectively covers the gesture to activate/check sleep mode.

I think you need a diff more like

diff --git a/source/eventHandler.py b/source/eventHandler.py
index 39e29456d8..4ed5a9b82b 100755
--- a/source/eventHandler.py
+++ b/source/eventHandler.py
@@ -410,6 +410,10 @@ def doPreGainFocus(obj: "NVDAObjects.NVDAObject", sleepMode: bool = False) -> bo
 		executeEvent("foreground", newForeground)
 	handlePossibleDesktopNameChange()
 	if sleepMode:
+		if oldFocus.sleepMode is False:
+			# If the old focus was not in sleep mode, we need to announce the new focus.
+			# Translators: message when sleep mode is activate
+			ui.message(_("Sleep mode activated"))
 		return True
 	# Fire focus entered events for all new ancestors of the focus if this is a gainFocus event
 	for parent in api.getFocusAncestors()[api.getFocusDifferenceLevel() :]: