Libraries.Interface.AccessibilityManager Documentation

Inherits from: Libraries.Language.Object, Libraries.Interface.Accessibility

Variables Table

VariablesDescription
integer ITEM_ADDED_NOTIFICATIONA constant used with the Notify action, indicating that a new item was added.
integer ACTION_ABORTED_NOTIFICATIONA constant used with the Notify action, indicating that the program had to abort some process.
integer ACTION_COMPLETED_NOTIFICATIONA constant used with the Notify action, indicating that an action was completed.
integer OTHER_NOTIFICATIONA constant used with the Notify action, indicating the notification relates to something that isn't described by the other notification constants.
integer ITEM_REMOVED_NOTIFICATIONA constant used with the Notify action, indicating that an item was removed.

Actions Documentation

Add(Libraries.Interface.Item item)

Handle the focus change.

Parameters

BoundsChanged(Libraries.Interface.Item item)

ButtonActivated(Libraries.Interface.Controls.Button button)

A constant used with the Notify action, indicating that an action was completed.

Parameters

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

ControlActivated(Libraries.Interface.Events.ControlActivationEvent event)

DescriptionChanged(Libraries.Interface.Item item)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

FocusChanged(Libraries.Interface.Events.FocusEvent event)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

IsScreenReaderListening()

Return

boolean

NameChanged(Libraries.Interface.Item item)

Notify(Libraries.Interface.Item item, text value, integer notificationType)

Parameters

Notify(Libraries.Interface.Item item, text value)

Parameters

ProgressBarValueChanged(Libraries.Interface.Events.ProgressBarValueChangedEvent progress)

A constant used with the Notify action, indicating that an item was removed.

Parameters

Remove(Libraries.Interface.Item item)

SelectionChanged(Libraries.Interface.Events.SelectionEvent event)

A constant used with the Notify action, indicating that a new item was added.

Parameters

Setup()

Accessibility may require custom setup for each platform. This action is called during StartGame, before a window is created.

Shutdown()

The Shutdown action shuts down the underlying accessibility architecture.

TextChanged(Libraries.Interface.Events.TextChangeEvent event)

TextFieldUpdatePassword(Libraries.Interface.Controls.TextField field)

ToggleButtonToggled(Libraries.Interface.Controls.ToggleButton button)

TreeChanged(Libraries.Interface.Events.TreeChangeEvent event)

TreeTableChanged(Libraries.Interface.Events.TreeTableChangeEvent event)

Update()

A constant used with the Notify action, indicating the notification relates to something that isn't described by the other notification constants.

WindowFocusChanged(Libraries.Interface.Events.WindowFocusEvent event)