Libraries.Interface.Accessibility.WebAccessibility Documentation
Inherits from: Libraries.Language.Object, Libraries.Interface.Accessibility
Actions Documentation
Add(Libraries.Interface.Item item)
This action indicates that an item should be explicitly added to the accessibility system.
Parameters
AddHiddenButton(text name)
Parameters
- text name
AddHiddenHeader(text name, text title)
Parameters
- text name
- text title
AddHiddenHeader(text name, text title, boolean attachToRoot)
Parameters
- text name
- text title
- boolean attachToRoot
AddHiddenLabel(text name, text words, boolean attachToRoot)
Parameters
- text name
- text words
- boolean attachToRoot
AddHiddenLabel(text name, text words)
Parameters
- text name
- text words
AddHiddenSlider(text name, integer min, integer max, integer step)
Parameters
- text name
- integer min
- integer max
- integer step
AddWebAccessibilityListener(Libraries.Interface.Events.WebAccessibilityListener listener)
BoundsChanged(Libraries.Interface.Item item)
Parameters
ButtonActivated(Libraries.Interface.Controls.Button button)
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
- Libraries.Language.Object: The object to compare to.
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)
Parameters
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Parameters
- Libraries.Language.Object: The to be compared.
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)
Parameters
FocusHiddenElement(text name)
Parameters
- text name
ForceReleaseFocus()
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
MenuChanged(Libraries.Interface.Events.MenuChangeEvent event)
ModifyHiddenLabel(text name, text words)
Parameters
- text name
- text words
ModifyHiddenSlider(text name, integer min, integer max, integer step)
Parameters
- text name
- integer min
- integer max
- integer step
NameChanged(Libraries.Interface.Item item)
Parameters
NativeAdd(Libraries.Interface.Item item)
NativeRemove(Libraries.Interface.Item item)
Notify(Libraries.Interface.Item item, text value, integer notificationType)
Parameters
- Libraries.Interface.Item
- text value
- integer notificationType
Notify(Libraries.Interface.Item item, text value)
Parameters
- Libraries.Interface.Item
- text value
NotifyListeners(Libraries.Interface.Events.WebAccessibilityEvent event)
ProgressBarValueChanged(Libraries.Interface.Events.ProgressBarValueChangedEvent progress)
Remove(Libraries.Interface.Item item)
This action indicates that an item should be explicitly removed from the accessibility system.
Parameters
Select(Libraries.Interface.Item item)
SelectionChanged(Libraries.Interface.Events.SelectionEvent event)
This action indicates that the selection has changed for a particular item.
Parameters
- Libraries.Interface.Events.SelectionEvent: this provides more information about how the selection was changed.
SetHiddenOnElement(text id, boolean hide)
Parameters
- text id
- boolean hide
SetHiddenSliderCurrentValue(text name, integer value)
Parameters
- text name
- integer value
SetHiddenSliderValueText(text name, text value)
Parameters
- text name
- text value
Setup()
Accessibility may require custom setup for each platform. This action is called during StartGame, before a window is created.
Shutdown()
TextChanged(Libraries.Interface.Events.TextChangeEvent event)
TextFieldUpdatePassword(Libraries.Interface.Controls.TextField field)
Parameters
TextSelectionChanged(Libraries.Interface.Selections.TextFieldSelection selection)
TextSelectionChanged(Libraries.Interface.Selections.TextBoxSelection selection)
ToggleButtonToggled(Libraries.Interface.Controls.ToggleButton button)
TreeChanged(Libraries.Interface.Events.TreeChangeEvent event)
TreeTableChanged(Libraries.Interface.Events.TreeTableChangeEvent event)
Update()
In some implementations, this triggers a focus change event.
WindowFocusChanged(Libraries.Interface.Events.WindowFocusEvent event)
On this page
Variables TableAction Documentation- Add(Libraries.Interface.Item item)
- AddHiddenButton(text name)
- AddHiddenHeader(text name, text title)
- AddHiddenHeader(text name, text title, boolean attachToRoot)
- AddHiddenLabel(text name, text words, boolean attachToRoot)
- AddHiddenLabel(text name, text words)
- AddHiddenSlider(text name, integer min, integer max, integer step)
- AddWebAccessibilityListener(Libraries.Interface.Events.WebAccessibilityListener listener)
- BoundsChanged(Libraries.Interface.Item item)
- ButtonActivated(Libraries.Interface.Controls.Button button)
- Compare(Libraries.Language.Object object)
- ControlActivated(Libraries.Interface.Events.ControlActivationEvent event)
- DescriptionChanged(Libraries.Interface.Item item)
- Equals(Libraries.Language.Object object)
- FocusChanged(Libraries.Interface.Events.FocusEvent event)
- FocusHiddenElement(text name)
- ForceReleaseFocus()
- GetHashCode()
- IsScreenReaderListening()
- MenuChanged(Libraries.Interface.Events.MenuChangeEvent event)
- ModifyHiddenLabel(text name, text words)
- ModifyHiddenSlider(text name, integer min, integer max, integer step)
- NameChanged(Libraries.Interface.Item item)
- NativeAdd(Libraries.Interface.Item item)
- NativeRemove(Libraries.Interface.Item item)
- Notify(Libraries.Interface.Item item, text value, integer notificationType)
- Notify(Libraries.Interface.Item item, text value)
- NotifyListeners(Libraries.Interface.Events.WebAccessibilityEvent event)
- ProgressBarValueChanged(Libraries.Interface.Events.ProgressBarValueChangedEvent progress)
- Remove(Libraries.Interface.Item item)
- Select(Libraries.Interface.Item item)
- SelectionChanged(Libraries.Interface.Events.SelectionEvent event)
- SetHiddenOnElement(text id, boolean hide)
- SetHiddenSliderCurrentValue(text name, integer value)
- SetHiddenSliderValueText(text name, text value)
- Setup()
- Shutdown()
- TextChanged(Libraries.Interface.Events.TextChangeEvent event)
- TextFieldUpdatePassword(Libraries.Interface.Controls.TextField field)
- TextSelectionChanged(Libraries.Interface.Selections.TextFieldSelection selection)
- TextSelectionChanged(Libraries.Interface.Selections.TextBoxSelection selection)
- ToggleButtonToggled(Libraries.Interface.Controls.ToggleButton button)
- TreeChanged(Libraries.Interface.Events.TreeChangeEvent event)
- TreeTableChanged(Libraries.Interface.Events.TreeTableChangeEvent event)
- Update()
- WindowFocusChanged(Libraries.Interface.Events.WindowFocusEvent event)