JUCE: AccessibleState Class Reference

JUCE

Public Member Functions | List of all members
AccessibleState Class Reference
juce_gui_basics » accessibility

Represents the state of an accessible UI element. More...

`#include <juce_AccessibilityState.h>`

## Public Member Functions
| AccessibleState ()=default
| Constructor. 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 | withSelectable () const noexcept
| Sets the selectable 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 | withSelected () const noexcept
| Sets the selected flag and returns the new state. More...
JUCE_NODISCARD AccessibleState | withAccessibleOffscreen () const noexcept
| Sets the accessible offscreen flag and returns the new state. 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...
bool | isAccessibleOffscreen () const noexcept
| Returns true if the UI element is accessible offscreen. More...

## Detailed Description

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.

See also
  AccessibilityHandler

## Constructor & Destructor Documentation

## ◆ AccessibleState()

AccessibleState::AccessibleState | ( |  | ) |
| 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.

## Member Function Documentation

## ◆ withCheckable()

JUCE_NODISCARD AccessibleState AccessibleState::withCheckable | ( |  | ) | const
| noexcept

Sets the checkable flag and returns the new state.

See also
  isCheckable

## ◆ withChecked()

JUCE_NODISCARD AccessibleState AccessibleState::withChecked | ( |  | ) | const
| noexcept

Sets the checked flag and returns the new state.

See also
  isChecked

## ◆ withCollapsed()

JUCE_NODISCARD AccessibleState AccessibleState::withCollapsed | ( |  | ) | const
| noexcept

Sets the collapsed flag and returns the new state.

See also
  isCollapsed

## ◆ withExpandable()

JUCE_NODISCARD AccessibleState AccessibleState::withExpandable | ( |  | ) | const
| noexcept

Sets the expandable flag and returns the new state.

See also
  isExpandable

## ◆ withExpanded()

JUCE_NODISCARD AccessibleState AccessibleState::withExpanded | ( |  | ) | const
| noexcept

Sets the expanded flag and returns the new state.

See also
  isExpanded

## ◆ withFocusable()

JUCE_NODISCARD AccessibleState AccessibleState::withFocusable | ( |  | ) | const
| noexcept

Sets the focusable flag and returns the new state.

See also
  isFocusable

## ◆ withFocused()

JUCE_NODISCARD AccessibleState AccessibleState::withFocused | ( |  | ) | const
| noexcept

Sets the focused flag and returns the new state.

See also
  isFocused

## ◆ withIgnored()

JUCE_NODISCARD AccessibleState AccessibleState::withIgnored | ( |  | ) | const
| noexcept

Sets the ignored flag and returns the new state.

See also
  isIgnored

## ◆ withSelectable()

JUCE_NODISCARD AccessibleState AccessibleState::withSelectable | ( |  | ) | const
| noexcept

Sets the selectable flag and returns the new state.

See also
  isSelectable

## ◆ withMultiSelectable()

JUCE_NODISCARD AccessibleState AccessibleState::withMultiSelectable | ( |  | ) | const
| noexcept

Sets the multiSelectable flag and returns the new state.

See also
  isMultiSelectable

## ◆ withSelected()

JUCE_NODISCARD AccessibleState AccessibleState::withSelected | ( |  | ) | const
| noexcept

Sets the selected flag and returns the new state.

See also
  isSelected

## ◆ withAccessibleOffscreen()

JUCE_NODISCARD AccessibleState AccessibleState::withAccessibleOffscreen | ( |  | ) | const
| noexcept

Sets the accessible offscreen flag and returns the new state.

See also
  isSelected

## ◆ isCheckable()

bool AccessibleState::isCheckable | ( |  | ) | const
| noexcept

Returns true if the UI element is checkable.

See also
  withCheckable

## ◆ isChecked()

bool AccessibleState::isChecked | ( |  | ) | const
| noexcept

Returns true if the UI element is checked.

See also
  withChecked

## ◆ isCollapsed()

bool AccessibleState::isCollapsed | ( |  | ) | const
| noexcept

Returns true if the UI element is collapsed.

See also
  withCollapsed

## ◆ isExpandable()

bool AccessibleState::isExpandable | ( |  | ) | const
| noexcept

Returns true if the UI element is expandable.

See also
  withExpandable

## ◆ isExpanded()

bool AccessibleState::isExpanded | ( |  | ) | const
| noexcept

Returns true if the UI element is expanded.

See also
  withExpanded

## ◆ isFocusable()

bool AccessibleState::isFocusable | ( |  | ) | const
| noexcept

Returns true if the UI element is focusable.

See also
  withFocusable

## ◆ isFocused()

bool AccessibleState::isFocused | ( |  | ) | const
| noexcept

Returns true if the UI element is focused.

See also
  withFocused

## ◆ isIgnored()

bool AccessibleState::isIgnored | ( |  | ) | const
| noexcept

Returns true if the UI element is ignored.

See also
  withIgnored

## ◆ isMultiSelectable()

bool AccessibleState::isMultiSelectable | ( |  | ) | const
| noexcept

Returns true if the UI element supports multiple item selection.

See also
  withMultiSelectable

## ◆ isSelectable()

bool AccessibleState::isSelectable | ( |  | ) | const
| noexcept

Returns true if the UI element is selectable.

See also
  withSelectable

## ◆ isSelected()

bool AccessibleState::isSelected | ( |  | ) | const
| noexcept

Returns true if the UI element is selected.

See also
  withSelected

## ◆ isAccessibleOffscreen()

bool AccessibleState::isAccessibleOffscreen | ( |  | ) | const
| noexcept

Returns true if the UI element is accessible offscreen.

See also
  withSelected

The documentation for this class was generated from the following file:

- juce_AccessibilityState.h