Base class for accessible Components. More...
#include <juce_AccessibilityHandler.h>
Classes | |
struct | Interfaces |
Utility struct which holds one or more accessibility interfaces. More... | |
Public Types | |
enum | AnnouncementPriority { AnnouncementPriority::low, AnnouncementPriority::medium, AnnouncementPriority::high } |
A priority level that can help an accessibility client determine how to handle an announcement request. More... | |
Public Member Functions | |
AccessibilityHandler (Component &componentToWrap, AccessibilityRole accessibilityRole, AccessibilityActions actions={}, Interfaces interfaces={}) | |
Constructor. More... | |
virtual | ~AccessibilityHandler () |
Destructor. More... | |
const AccessibilityActions & | getActions () const noexcept |
Returns the set of actions that the UI element supports and the associated callbacks. More... | |
AccessibilityCellInterface * | getCellInterface () const |
Returns the cell interface for this UI element, or nullptr if it is not supported. More... | |
AccessibilityHandler * | getChildAt (Point< int > screenPoint) |
Returns the deepest child of this UI element in the accessibility hierarchy that contains the given screen point, or nullptr if there is no child at this point. More... | |
AccessibilityHandler * | getChildFocus () |
Returns the deepest UI element which currently has focus. More... | |
std::vector< AccessibilityHandler * > | getChildren () const |
Returns the unignored children of this UI element in the accessibility hierarchy. More... | |
const Component & | getComponent () const noexcept |
Returns the Component that this handler represents. More... | |
Component & | getComponent () noexcept |
Returns the Component that this handler represents. More... | |
virtual AccessibleState | getCurrentState () const |
Returns the current state of the UI element. More... | |
virtual String | getDescription () const |
A short description of the UI element. More... | |
virtual String | getHelp () const |
Some help text for the UI element (if required). More... | |
AccessibilityNativeHandle * | getNativeImplementation () const |
AccessibilityHandler * | getParent () const |
Returns the first unignored parent of this UI element in the accessibility hierarchy, or nullptr if this is a root element without a parent. More... | |
AccessibilityRole | getRole () const noexcept |
The type of UI element that this accessibility handler represents. More... | |
AccessibilityTableInterface * | getTableInterface () const |
Returns the table interface for this UI element, or nullptr if it is not supported. More... | |
AccessibilityTextInterface * | getTextInterface () const |
Returns the text interface for this UI element, or nullptr if it is not supported. More... | |
virtual String | getTitle () const |
The title of the UI element. More... | |
std::type_index | getTypeIndex () const |
AccessibilityValueInterface * | getValueInterface () const |
Returns the value interface for this UI element, or nullptr if it is not supported. More... | |
void | giveAwayFocus () const |
If this UI element or any of its children in the accessibility hierarchy currently have focus, this will defocus it. More... | |
void | grabFocus () |
Tries to give focus to this UI element. More... | |
bool | hasFocus (bool trueIfChildFocused) const |
Returns true if this UI element has the focus. More... | |
bool | isIgnored () const |
Returns true if this UI element should be ignored by accessibility clients. More... | |
bool | isParentOf (const AccessibilityHandler *possibleChild) const noexcept |
Checks whether a given UI element is a child of this one in the accessibility hierarchy. More... | |
bool | isVisibleWithinParent () const |
Returns true if this UI element is visible within its parent. More... | |
void | notifyAccessibilityEvent (AccessibilityEvent event) const |
Used to send a notification to any observing accessibility clients that something has changed in the UI element. More... | |
Static Public Member Functions | |
static void | postAnnouncement (const String &announcementString, AnnouncementPriority priority) |
Posts an announcement to be made to the user. More... | |
Private Member Functions | |
void | giveAwayFocusInternal () const |
void | grabFocusInternal (bool) |
void | takeFocus () |
Static Private Member Functions | |
static std::unique_ptr< AccessibilityNativeImpl > | createNativeImpl (AccessibilityHandler &) |
Private Attributes | |
AccessibilityActions | actions |
Component & | component |
Interfaces | interfaces |
std::unique_ptr< AccessibilityNativeImpl > | nativeImpl |
const AccessibilityRole | role |
std::type_index | typeIndex |
Static Private Attributes | |
static AccessibilityHandler * | currentlyFocusedHandler |
Friends | |
class | AccessibilityNativeHandle |
Base class for accessible Components.
This class wraps a Component and provides methods that allow an accessibility client, such as VoiceOver on macOS, or Narrator on Windows, to control it.
It handles hierarchical navigation, properties, state, and various interfaces.
@tags{Accessibility}
|
strong |
A priority level that can help an accessibility client determine how to handle an announcement request.
Exactly what this controls is platform-specific, but generally a low priority announcement will be read when the screen reader is free, whereas a high priority announcement will interrupt the current speech.
Enumerator | |
---|---|
low | |
medium | |
high |
juce::AccessibilityHandler::AccessibilityHandler | ( | Component & | componentToWrap, |
AccessibilityRole | accessibilityRole, | ||
AccessibilityActions | actions = {} , |
||
Interfaces | interfaces = {} |
||
) |
Constructor.
This will create a AccessibilityHandler which wraps the provided Component and makes it visible to accessibility clients. You must also specify a role for the UI element from the AccessibilityRole
list which best describes it.
To enable users to interact with the UI element you should provide the set of supported actions and their associated callbacks via the accessibilityActions
parameter.
For UI elements that support more complex interaction the value, text, table, and cell interfaces should be implemented as required and passed as the final argument of this constructor. See the documentation of these classes for more information about the types of control they represent and which methods need to be implemented.
|
virtual |
Destructor.
|
staticprivate |
|
noexcept |
Returns the set of actions that the UI element supports and the associated callbacks.
AccessibilityCellInterface* juce::AccessibilityHandler::getCellInterface | ( | ) | const |
Returns the cell interface for this UI element, or nullptr if it is not supported.
AccessibilityHandler* juce::AccessibilityHandler::getChildAt | ( | Point< int > | screenPoint | ) |
Returns the deepest child of this UI element in the accessibility hierarchy that contains the given screen point, or nullptr if there is no child at this point.
AccessibilityHandler* juce::AccessibilityHandler::getChildFocus | ( | ) |
Returns the deepest UI element which currently has focus.
This can be a child of this UI element or, if no child is focused, this element itself.
Note that this can be different to the value of the Component with keyboard focus returned by Component::getCurrentlyFocusedComponent().
std::vector<AccessibilityHandler*> juce::AccessibilityHandler::getChildren | ( | ) | const |
Returns the unignored children of this UI element in the accessibility hierarchy.
|
inlinenoexcept |
Returns the Component that this handler represents.
Referenced by juce::UIATransformProvider::getPeer(), juce::UIAWindowProvider::getPeer(), and juce::AccessibilityNativeHandle::isFragmentRoot().
|
inlinenoexcept |
Returns the Component that this handler represents.
|
virtual |
Returns the current state of the UI element.
The default implementation of this method will set the focusable flag and, if this UI element is currently focused, will also set the focused flag.
Referenced by juce::UIAExpandCollapseProvider::get_ExpandCollapseState(), juce::UIAToggleProvider::getCurrentToggleState(), and juce::UIASelectionProvider::isMultiSelectable().
|
inlinevirtual |
A short description of the UI element.
This may be read out by the system. It should not include the type of the UI element and should ideally be a single word, for example "Open" for a button that opens a window.
The default implementation will call Component::getDescription()
, but you can override this to return a different string if required.
If neither a name nor a description is provided then the UI element may be ignored by accessibility clients.
This must be a localised string.
|
inlinevirtual |
Some help text for the UI element (if required).
This may be read out by the system. This string functions in a similar way to a tooltip, for example "Click to open window." for a button which opens a window.
The default implementation will call Component::getHelpText()
, but you can override this to return a different string if required.
This must be a localised string.
AccessibilityNativeHandle* juce::AccessibilityHandler::getNativeImplementation | ( | ) | const |
AccessibilityHandler* juce::AccessibilityHandler::getParent | ( | ) | const |
Returns the first unignored parent of this UI element in the accessibility hierarchy, or nullptr if this is a root element without a parent.
|
inlinenoexcept |
The type of UI element that this accessibility handler represents.
AccessibilityTableInterface* juce::AccessibilityHandler::getTableInterface | ( | ) | const |
Returns the table interface for this UI element, or nullptr if it is not supported.
AccessibilityTextInterface* juce::AccessibilityHandler::getTextInterface | ( | ) | const |
Returns the text interface for this UI element, or nullptr if it is not supported.
|
inlinevirtual |
The title of the UI element.
This will be read out by the system and should be concise, preferably matching the visible title of the UI element (if any). For example, this might be the text of a button or a simple label.
The default implementation will call Component::getTitle()
, but you can override this to return a different string if required.
If neither a name nor a description is provided then the UI element may be ignored by accessibility clients.
This must be a localised string.
|
inline |
AccessibilityValueInterface* juce::AccessibilityHandler::getValueInterface | ( | ) | const |
Returns the value interface for this UI element, or nullptr if it is not supported.
Referenced by juce::UIAValueProvider::get_IsReadOnly(), and juce::UIAValueProvider::get_Value().
void juce::AccessibilityHandler::giveAwayFocus | ( | ) | const |
If this UI element or any of its children in the accessibility hierarchy currently have focus, this will defocus it.
This will also give away the keyboard focus from the Component it represents, and notify any listening accessibility clients that the current focus has changed.
|
private |
void juce::AccessibilityHandler::grabFocus | ( | ) |
Tries to give focus to this UI element.
If the UI element is focusable and not ignored this will update the currently focused element, try to give keyboard focus to the Component it represents, and notify any listening accessibility clients that the current focus has changed.
|
private |
Returns true if this UI element has the focus.
trueIfChildFocused | if this is true, this method will also return true if any child of this UI element in the accessibility hierarchy has focus |
Referenced by juce::UIATextProvider::GetCaretRange().
bool juce::AccessibilityHandler::isIgnored | ( | ) | const |
Returns true if this UI element should be ignored by accessibility clients.
|
noexcept |
Checks whether a given UI element is a child of this one in the accessibility hierarchy.
bool juce::AccessibilityHandler::isVisibleWithinParent | ( | ) | const |
Returns true if this UI element is visible within its parent.
This will always return true for UI elements with the AccessibleState::accessibleOffscreen flag set.
void juce::AccessibilityHandler::notifyAccessibilityEvent | ( | AccessibilityEvent | event | ) | const |
Used to send a notification to any observing accessibility clients that something has changed in the UI element.
|
static |
Posts an announcement to be made to the user.
announcementString | a localised string containing the announcement to be read out |
priority | the appropriate priority level for the announcement |
|
private |
|
friend |
|
private |
|
private |
|
staticprivate |
|
private |
|
private |
|
private |
|
private |