App Modules

import appModuleHandler
import globalPluginHandler

class GlobalPlugin(globalPluginHandler.GlobalPlugin):

	def __init__(self, *args, **kwargs):
		super().__init__(*args, **kwargs)
		# Map "time.exe" to "time_app_mod" module
		appModuleHandler.registerExecutableWithAppModule("time", "time_app_mod")

	def terminate(self, *args, **kwargs):
		super().terminate(*args, **kwargs)
		appModuleHandler.unregisterExecutable("time")

import appModuleHandler
from scriptHandler import script
import ui
import api

class AppModule(appModuleHandler.AppModule):

	@script(
		description="Announces the current object's class name",
		category="My Application",
		gesture="kb:NVDA+shift+c"
	)
	def script_announceClassName(self, gesture):
		"""Announce the window class name."""
		focusObj = api.getFocusObject()
		ui.message(f"Class: {focusObj.windowClassName}")

	@script(
		description="Announces window control ID",
		gestures=["kb:NVDA+shift+i", "kb:NVDA+alt+i"]
	)
	def script_announceControlID(self, gesture):
		"""Announce the control ID."""
		focusObj = api.getFocusObject()
		ui.message(f"Control ID: {focusObj.windowControlID}")

class AppModule(appModuleHandler.AppModule):
	
	# The process ID (read-only, set in __init__)
	processID: int
	
	# The application name (read-only, set in __init__)
	appName: str
	
	# Handle to the process
	processHandle: int
	
	# Whether NVDA should sleep in this application
	sleepMode: bool = False
	
	# Product name from executable version info
	productName: str
	
	# Product version from executable version info
	productVersion: str
	
	# Whether the process is 64-bit
	is64BitProcess: bool
	
	# Whether this is a Windows Store app
	isWindowsStoreApp: bool

import appModuleHandler

class AppModule(appModuleHandler.AppModule):
	"""App module for a self-voicing application."""
	
	sleepMode = True

import appModuleHandler
from NVDAObjects.IAccessible import IAccessible
import controlTypes

class AppModule(appModuleHandler.AppModule):

	def chooseNVDAObjectOverlayClasses(self, obj, clsList):
		"""Choose overlay classes for objects in this application."""
		if obj.windowClassName == "CustomButton":
			# Insert custom class at the beginning
			clsList.insert(0, CustomButton)

class CustomButton(IAccessible):
	"""Custom handling for custom buttons."""
	
	def _get_name(self):
		"""Provide better name for custom buttons."""
		name = super().name
		return f"Custom: {name}"
	
	def _get_role(self):
		"""Override role."""
		return controlTypes.Role.BUTTON

import appModuleHandler

class AppModule(appModuleHandler.AppModule):

	def isGoodUIAWindow(self, hwnd):
		"""Return True if UIA should be used for this window."""
		# Check window class name and force UIA
		return False

	def isBadUIAWindow(self, hwnd):
		"""Return True if UIA should be avoided for this window."""
		# Detect broken UIA implementations
		return False

	def shouldProcessUIAPropertyChangedEvent(self, sender, propertyId):
		"""Control whether to process UIA property changes."""
		# Filter out noisy events
		return True

# myapp.py
# App Module for My Application

import appModuleHandler
from scriptHandler import script
import api
import ui
import controlTypes
from NVDAObjects.IAccessible import IAccessible

class AppModule(appModuleHandler.AppModule):

	def __init__(self, *args, **kwargs):
		super().__init__(*args, **kwargs)
		self.customData = {}

	def event_appModule_gainFocus(self):
		"""Application gained focus."""
		ui.message("My Application")

	def event_gainFocus(self, obj, nextHandler):
		"""Handle focus events."""
		if obj.role == controlTypes.Role.LISTITEM:
			# Custom handling for list items
			self._announceListItem(obj)
		nextHandler()

	def _announceListItem(self, obj):
		"""Custom announcement for list items."""
		position = obj.positionInfo
		if position:
			ui.message(
				f"{obj.name}, item {position['indexInGroup']} of {position['similarItemsInGroup']}"
			)

	@script(
		description="Shows custom information",
		category="My Application",
		gesture="kb:NVDA+shift+i"
	)
	def script_showInfo(self, gesture):
		"""Display custom information dialog."""
		focusObj = api.getFocusObject()
		ui.message(f"Object: {focusObj.name}, Role: {focusObj.role}")

	def chooseNVDAObjectOverlayClasses(self, obj, clsList):
		"""Customize NVDA objects."""
		if obj.windowClassName == "MyCustomControl":
			clsList.insert(0, MyCustomControl)

class MyCustomControl(IAccessible):
	"""Custom NVDA object for MyCustomControl."""
	
	def _get_name(self):
		"""Provide better name."""
		# Custom logic to get name
		return super().name or "Unnamed custom control"
	
	def _get_description(self):
		"""Provide helpful description."""
		return "This is a custom control"