AccessibleProperty#

The possible accessible properties of a Accessible.

Methods#

class AccessibleProperty

init_value(value: Value) → None#

Initializes value with the appropriate type for the property.

This function is mostly meant for language bindings, in conjunction with update_property_value().

class AccessibleProperty

AUTOCOMPLETE#: Indicates whether inputting text could trigger display of one or more predictions of the user’s intended value for a combobox, searchbox, or textbox and specifies how predictions would be presented if they were made. Value type: AccessibleAutocomplete

DESCRIPTION#: Defines a string value that describes or annotates the current element. Value type: string

HAS_POPUP#: Indicates the availability of interactive popup element, such as menu or popover, that can be triggered by an element. Contrary to “aria-haspopup”, it doesn’t indicate the type of the element, as such it cannot be used to indicate the availability of more complex elements such as dialog. Value type: boolean

HELP_TEXT#: Defines a string value that provides a description of non-standard keyboard interactions of the current element. Value type: string

Added in version 4.16.

KEY_SHORTCUTS#: Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. Value type: string. The format of the value is a space-separated list of shortcuts, with each shortcut consisting of one or more modifiers (Control, Alt or Shift), followed by a non-modifier key, all separated by +. The WAI-ARIA reference specifies how to build keyboard shortcuts strings, with specific values for each key which are the same regardless of the language, so these strings can’t be built from localized key names. You can convert an accelerator into the matching key shortcuts label with accelerator_get_accessible_label. Examples: F2, Alt+F, Control+Shift+N

LABEL#: Defines a string value that labels the current element. Value type: string

LEVEL#: Defines the hierarchical level of an element within a structure. Value type: integer

MODAL#: Indicates whether an element is modal when displayed. Value type: boolean

MULTI_LINE#: Indicates whether a text box accepts multiple lines of input or only a single line. Value type: boolean

MULTI_SELECTABLE#: Indicates that the user may select more than one item from the current selectable descendants. Value type: boolean

ORIENTATION#: Indicates whether the element’s orientation is horizontal, vertical, or unknown/ambiguous. Value type: Orientation

PLACEHOLDER#: Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. Value type: string

READ_ONLY#: Indicates that the element is not editable, but is otherwise operable. Value type: boolean

REQUIRED#: Indicates that user input is required on the element before a form may be submitted. Value type: boolean

ROLE_DESCRIPTION#: Defines a human-readable, author-localized description for the role of an element. Value type: string

SORT#: Indicates if items in a table or grid are sorted in ascending or descending order. Value type: AccessibleSort

VALUE_MAX#: Defines the maximum allowed value for a range widget. Value type: double

VALUE_MIN#: Defines the minimum allowed value for a range widget. Value type: double

VALUE_NOW#: Defines the current value for a range widget. Value type: double

VALUE_TEXT#: Defines the human readable text alternative of VALUE_NOW for a range widget. Value type: string