Public Member Functions | |
| ButtonAccessibilityHandler (Button &buttonToWrap, AccessibilityRole roleIn) | |
| AccessibleState | getCurrentState () const override |
| Returns the current state of the UI element. | |
| String | getTitle () const override |
| The title of the UI element. | |
| String | getHelp () const override |
| Some help text for the UI element (if required). | |
 Public Member Functions inherited from juce::AccessibilityHandler | |
| AccessibilityHandler (Component &componentToWrap, AccessibilityRole accessibilityRole, AccessibilityActions actions={}, Interfaces interfaces={}) | |
| Constructor. | |
| virtual | ~AccessibilityHandler () |
| Destructor. | |
| const Component & | getComponent () const noexcept |
| Returns the Component that this handler represents. | |
| Component & | getComponent () noexcept |
| Returns the Component that this handler represents. | |
| AccessibilityRole | getRole () const noexcept |
| The type of UI element that this accessibility handler represents. | |
| virtual String | getDescription () const |
| A short description of the UI element. | |
| bool | isIgnored () const |
| Returns true if this UI element should be ignored by accessibility clients. | |
| bool | isVisibleWithinParent () const |
| Returns true if this UI element is visible within its parent. | |
| const AccessibilityActions & | getActions () const noexcept |
| Returns the set of actions that the UI element supports and the associated callbacks. | |
| AccessibilityValueInterface * | getValueInterface () const |
| Returns the value interface for this UI element, or nullptr if it is not supported. | |
| AccessibilityTableInterface * | getTableInterface () const |
| Returns the table interface for this UI element, or nullptr if it is not supported. | |
| AccessibilityCellInterface * | getCellInterface () const |
| Returns the cell interface for this UI element, or nullptr if it is not supported. | |
| AccessibilityTextInterface * | getTextInterface () const |
| Returns the text interface for this UI element, or nullptr if it is not supported. | |
| 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. | |
| std::vector< AccessibilityHandler * > | getChildren () const |
| Returns the unignored children of this UI element in the accessibility hierarchy. | |
| bool | isParentOf (const AccessibilityHandler *possibleChild) const noexcept |
| Checks whether a given UI element is a child of this one in the accessibility hierarchy. | |
| 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 * | getChildFocus () |
| Returns the deepest UI element which currently has focus. | |
| bool | hasFocus (bool trueIfChildFocused) const |
| Returns true if this UI element has the focus. | |
| void | grabFocus () |
| Tries to give focus to this UI element. | |
| void | giveAwayFocus () const |
| If this UI element or any of its children in the accessibility hierarchy currently have focus, this will defocus it. | |
| void | notifyAccessibilityEvent (AccessibilityEvent event) const |
| Used to send a notification to any observing accessibility clients that something has changed in the UI element. | |
| AccessibilityNativeHandle * | getNativeImplementation () const |
| std::type_index | getTypeIndex () const |
Additional Inherited Members | |
| Public Types inherited from juce::AccessibilityHandler | |
| enum class | AnnouncementPriority { low , medium , high } |
| A priority level that can help an accessibility client determine how to handle an announcement request. More... | |
| Static Public Member Functions inherited from juce::AccessibilityHandler | |
| static void | postAnnouncement (const String &announcementString, AnnouncementPriority priority) |
| Posts an announcement to be made to the user. | |
| static void | clearCurrentlyFocusedHandler () |
| static void * | getNativeChildForComponent (Component &component) |
| static void | setNativeChildForComponent (Component &component, void *nativeChild) |
| static Component * | getComponentForNativeChild (void *nativeChild) |
Detailed Description
Definition at line 30 of file juce_ButtonAccessibilityHandler.h.
Constructor & Destructor Documentation
◆ ButtonAccessibilityHandler()
| juce::detail::ButtonAccessibilityHandler::ButtonAccessibilityHandler | ( | Button & | buttonToWrap, |
| AccessibilityRole | roleIn | ||
| ) |
Definition at line 33 of file juce_ButtonAccessibilityHandler.h.
Member Function Documentation
◆ getCurrentState()
|
overridevirtual |
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.
Reimplemented from juce::AccessibilityHandler.
Definition at line 42 of file juce_ButtonAccessibilityHandler.h.
◆ getHelp()
|
overridevirtual |
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.
Reimplemented from juce::AccessibilityHandler.
Definition at line 68 of file juce_ButtonAccessibilityHandler.h.
◆ getTitle()
|
overridevirtual |
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.
Reimplemented from juce::AccessibilityHandler.
Definition at line 58 of file juce_ButtonAccessibilityHandler.h.
The documentation for this class was generated from the following file:
- juce_gui_basics/detail/juce_ButtonAccessibilityHandler.h