easeOfAccess module

Utilities for working with the Windows Ease of Access Center.

class easeOfAccess.RegistryKey(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

ROOT = 'Software\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility'
TEMP = 'Software\\Microsoft\\Windows NT\\CurrentVersion\\AccessibilityTemp'
APP = 'Software\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility\\ATs\\nvda_nvda_v1'
_generate_next_value_(start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

_new_member_(**kwargs)

Create and return a new object. See help(type) for accurate signature.

_use_args_ = True
_member_names_ = ['ROOT', 'TEMP', 'APP']
_member_map_ = {'APP': RegistryKey.APP, 'ROOT': RegistryKey.ROOT, 'TEMP': RegistryKey.TEMP}
_value2member_map_ = {'Software\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility': RegistryKey.ROOT, 'Software\\Microsoft\\Windows NT\\CurrentVersion\\AccessibilityTemp': RegistryKey.TEMP, 'Software\\Microsoft\\Windows NT\\CurrentVersion\\Accessibility\\ATs\\nvda_nvda_v1': RegistryKey.APP}
_unhashable_values_ = []
_member_type_

alias of str

_value_repr_()

Return repr(self).

class easeOfAccess.AutoStartContext(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Registry HKEY used for tracking when NVDA starts automatically

ON_LOGON_SCREEN = 2147483650
AFTER_LOGON = 2147483649
easeOfAccess.isRegistered() bool
easeOfAccess.notify(signal)
easeOfAccess.willAutoStart(autoStartContext: AutoStartContext) bool
Based on autoStartContext, gets whether NVDA starts automatically:
  • AutoStartContext.ON_LOGON_SCREEN : on the logon screen

  • AutoStartContext.AFTER_LOGON : after logging on

Returns False on failure

easeOfAccess._getAutoStartConfiguration(autoStartContext: AutoStartContext) List[str]
Based on autoStartContext, returns a list of app names which start automatically:
  • AutoStartContext.ON_LOGON_SCREEN : on the logon screen

  • AutoStartContext.AFTER_LOGON : after logging on

Returns an empty list on failure.

easeOfAccess.setAutoStart(autoStartContext: AutoStartContext, enable: bool) None
Based on autoStartContext, sets NVDA to start automatically:
  • AutoStartContext.ON_LOGON_SCREEN : on the logon screen

  • AutoStartContext.AFTER_LOGON : after logging on

May incorrectly set autoStart to False upon failing to fetch the previously set value from the registry.

Raises Union[WindowsError, FileNotFoundError]