Represents the state of an accessible UI element. More...
#include <juce_AccessibilityState.h>
Public Member Functions | |
AccessibleState ()=default | |
Constructor. More... | |
bool | isAccessibleOffscreen () const noexcept |
Returns true if the UI element is accessible offscreen. More... | |
bool | isCheckable () const noexcept |
Returns true if the UI element is checkable. More... | |
bool | isChecked () const noexcept |
Returns true if the UI element is checked. More... | |
bool | isCollapsed () const noexcept |
Returns true if the UI element is collapsed. More... | |
bool | isExpandable () const noexcept |
Returns true if the UI element is expandable. More... | |
bool | isExpanded () const noexcept |
Returns true if the UI element is expanded. More... | |
bool | isFocusable () const noexcept |
Returns true if the UI element is focusable. More... | |
bool | isFocused () const noexcept |
Returns true if the UI element is focused. More... | |
bool | isIgnored () const noexcept |
Returns true if the UI element is ignored. More... | |
bool | isMultiSelectable () const noexcept |
Returns true if the UI element supports multiple item selection. More... | |
bool | isSelectable () const noexcept |
Returns true if the UI element is selectable. More... | |
bool | isSelected () const noexcept |
Returns true if the UI element is selected. More... | |
JUCE_NODISCARD AccessibleState | withAccessibleOffscreen () const noexcept |
Sets the accessible offscreen flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withCheckable () const noexcept |
Sets the checkable flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withChecked () const noexcept |
Sets the checked flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withCollapsed () const noexcept |
Sets the collapsed flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withExpandable () const noexcept |
Sets the expandable flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withExpanded () const noexcept |
Sets the expanded flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withFocusable () const noexcept |
Sets the focusable flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withFocused () const noexcept |
Sets the focused flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withIgnored () const noexcept |
Sets the ignored flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withMultiSelectable () const noexcept |
Sets the multiSelectable flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withSelectable () const noexcept |
Sets the selectable flag and returns the new state. More... | |
JUCE_NODISCARD AccessibleState | withSelected () const noexcept |
Sets the selected flag and returns the new state. More... | |
Private Types | |
enum | Flags { checkable = (1 << 0), checked = (1 << 1), collapsed = (1 << 2), expandable = (1 << 3), expanded = (1 << 4), focusable = (1 << 5), focused = (1 << 6), ignored = (1 << 7), multiSelectable = (1 << 8), selectable = (1 << 9), selected = (1 << 10), accessibleOffscreen = (1 << 11) } |
Private Member Functions | |
bool | isFlagSet (int flag) const noexcept |
JUCE_NODISCARD AccessibleState | withFlag (int flag) const noexcept |
Private Attributes | |
int | flags = 0 |
Represents the state of an accessible UI element.
An instance of this class is returned by AccessibilityHandler::getCurrentState()
to convey its current state to an accessibility client.
@tags{Accessibility}
|
private |
|
default |
Constructor.
Represents a "default" state with no flags set. To set a flag, use one of the withX()
methods - these can be chained together to set multiple flags.
|
inlinenoexcept |
Returns true if the UI element is accessible offscreen.
|
inlinenoexcept |
Returns true if the UI element is checkable.
|
inlinenoexcept |
Returns true if the UI element is checked.
Referenced by juce::UIAToggleProvider::getCurrentToggleState().
|
inlinenoexcept |
Returns true if the UI element is collapsed.
|
inlinenoexcept |
Returns true if the UI element is expandable.
|
inlinenoexcept |
Returns true if the UI element is expanded.
Referenced by juce::UIAExpandCollapseProvider::get_ExpandCollapseState().
References juce::gl::flags.
|
inlinenoexcept |
Returns true if the UI element is focusable.
|
inlinenoexcept |
Returns true if the UI element is focused.
|
inlinenoexcept |
Returns true if the UI element is ignored.
|
inlinenoexcept |
Returns true if the UI element supports multiple item selection.
Referenced by juce::UIASelectionProvider::isMultiSelectable().
|
inlinenoexcept |
Returns true if the UI element is selectable.
|
inlinenoexcept |
Returns true if the UI element is selected.
|
inlinenoexcept |
Sets the accessible offscreen flag and returns the new state.
|
inlinenoexcept |
Sets the checkable flag and returns the new state.
|
inlinenoexcept |
Sets the checked flag and returns the new state.
|
inlinenoexcept |
Sets the collapsed flag and returns the new state.
|
inlinenoexcept |
Sets the expandable flag and returns the new state.
|
inlinenoexcept |
Sets the expanded flag and returns the new state.
|
inlineprivatenoexcept |
References juce::StandardApplicationCommandIDs::copy.
|
inlinenoexcept |
Sets the focusable flag and returns the new state.
|
inlinenoexcept |
Sets the focused flag and returns the new state.
|
inlinenoexcept |
Sets the ignored flag and returns the new state.
|
inlinenoexcept |
Sets the multiSelectable flag and returns the new state.
|
inlinenoexcept |
Sets the selectable flag and returns the new state.
|
inlinenoexcept |
Sets the selected flag and returns the new state.
|
private |