JUCE: accessibility

JUCE

Classes | Enumerations
accessibility
juce_gui_basics

## Classes
class | AccessibilityActions
| A simple wrapper for building a collection of supported accessibility actions and corresponding callbacks for a UI element. More...
class | AccessibilityCellInterface
| An abstract interface which represents a UI element that supports a cell interface. More...
class | AccessibilityTableInterface
| An abstract interface which represents a UI element that supports a table interface. More...
struct | AccessibilityTableInterface::Span
class | AccessibilityTextInterface
| An abstract interface which represents a UI element that supports a text interface. More...
class | AccessibilityValueInterface
| An abstract interface representing the value of an accessibility element. More...
class | AccessibilityValueInterface::AccessibleValueRange
| Represents the range of this value, if supported. More...
struct | AccessibilityValueInterface::AccessibleValueRange::MinAndMax
| The minimum and maximum values for this range, inclusive. More...
class | AccessibilityTextValueInterface
| A value interface that represents a text value. More...
class | AccessibilityNumericValueInterface
| A value interface that represents a non-ranged numeric value. More...
class | AccessibilityRangedNumericValueInterface
| A value interface that represents a ranged numeric value. More...
class | AccessibilityHandler
| Base class for accessible Components. More...
struct | AccessibilityHandler::Interfaces
| Utility struct which holds one or more accessibility interfaces. More...
class | AccessibleState
| Represents the state of an accessible UI element. More...

## Enumerations
enum class | AccessibilityActionType { AccessibilityActionType::press , AccessibilityActionType::toggle , AccessibilityActionType::focus , AccessibilityActionType::showMenu }
| An action that can be performed by an accessible UI element. More...
enum class | AccessibilityEvent { AccessibilityEvent::valueChanged , AccessibilityEvent::titleChanged , AccessibilityEvent::structureChanged , AccessibilityEvent::textSelectionChanged , AccessibilityEvent::textChanged , AccessibilityEvent::rowSelectionChanged }
| A list of events that can be notified to any subscribed accessibility clients. More...
enum class | AccessibilityRole { AccessibilityRole::button , AccessibilityRole::toggleButton , AccessibilityRole::radioButton , AccessibilityRole::comboBox , AccessibilityRole::image , AccessibilityRole::slider , AccessibilityRole::label , AccessibilityRole::staticText , AccessibilityRole::editableText , AccessibilityRole::menuItem , AccessibilityRole::menuBar , AccessibilityRole::popupMenu , AccessibilityRole::table , AccessibilityRole::tableHeader , AccessibilityRole::column , AccessibilityRole::row , AccessibilityRole::cell , AccessibilityRole::hyperlink , AccessibilityRole::list , AccessibilityRole::listItem , AccessibilityRole::tree , AccessibilityRole::treeItem , AccessibilityRole::progressBar , AccessibilityRole::group , AccessibilityRole::dialogWindow , AccessibilityRole::window , AccessibilityRole::scrollBar , AccessibilityRole::tooltip , AccessibilityRole::splashScreen , AccessibilityRole::ignored , AccessibilityRole::unspecified }
| The list of available roles for an AccessibilityHandler object. More...

## Detailed Description

## Enumeration Type Documentation

## ◆ AccessibilityActionType

enum class AccessibilityActionType
| strong

An action that can be performed by an accessible UI element.

Enumerator
press | Represents a "press" action.
    This will be called when the user "clicks" the UI element using an
    accessibility client.
toggle | Represents a "toggle" action.
    This will be called when the user toggles the state of a UI element,
    for example a toggle button or the selection of a list item.
focus | Indicates that the UI element has received focus.
    This will be called when a UI element receives focus from an accessibility
    client, or keyboard focus from the application.
showMenu | Represents the user showing a contextual menu for a UI element.
    This will be called for UI elements which expand and collapse to
    show contextual information or menus, or show a popup.

## ◆ AccessibilityEvent

enum class AccessibilityEvent
| strong

A list of events that can be notified to any subscribed accessibility clients.

To post a notification, call `AccessibilityHandler::notifyAccessibilityEvent` on the associated handler with the appropriate `AccessibilityEvent` type and listening clients will be notified.

Enumerator
valueChanged | Indicates that the UI element's value has changed.
    This should be called on the handler that implements `AccessibilityValueInterface`
    for the UI element that has changed.
titleChanged | Indicates that the title of the UI element has changed.
    This should be called on the handler whose title has changed.
structureChanged | Indicates that the structure of the UI elements has changed in a significant way. This should be called on the top-level handler whose structure has changed.
textSelectionChanged | Indicates that the selection of a text element has changed.
    This should be called on the handler that implements `AccessibilityTextInterface`
    for the text element that has changed.
textChanged | Indicates that the visible text of a text element has changed.
    This should be called on the handler that implements `AccessibilityTextInterface`
    for the text element that has changed.
rowSelectionChanged | Indicates that the selection of rows in a list or table has changed.
    This should be called on the handler that implements `AccessibilityTableInterface`
    for the UI element that has changed.

## ◆ AccessibilityRole

enum class AccessibilityRole
| strong

The list of available roles for an AccessibilityHandler object.

When creating a custom AccessibilityHandler you should select the role that best describes the UI element being represented.

Enumerator
button |
toggleButton |
radioButton |
comboBox |
image |
slider |
label |
staticText |
editableText |
menuItem |
menuBar |
popupMenu |
table |
tableHeader |
column |
row |
cell |
hyperlink |
list |
listItem |
tree |
treeItem |
progressBar |
group |
dialogWindow |
window |
scrollBar |
tooltip |
splashScreen |
ignored |
unspecified |