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

#include <juce_AccessibilityState.h>

Collaboration diagram for juce::AccessibleState:

Public Member Functions
	AccessibleState ()=default
	Constructor.

bool	isAccessibleOffscreen () const noexcept
	Returns true if the UI element is accessible offscreen.

bool	isCheckable () const noexcept
	Returns true if the UI element is checkable.

bool	isChecked () const noexcept
	Returns true if the UI element is checked.

bool	isCollapsed () const noexcept
	Returns true if the UI element is collapsed.

bool	isExpandable () const noexcept
	Returns true if the UI element is expandable.

bool	isExpanded () const noexcept
	Returns true if the UI element is expanded.

bool	isFocusable () const noexcept
	Returns true if the UI element is focusable.

bool	isFocused () const noexcept
	Returns true if the UI element is focused.

bool	isIgnored () const noexcept
	Returns true if the UI element is ignored.

bool	isMultiSelectable () const noexcept
	Returns true if the UI element supports multiple item selection.

bool	isSelectable () const noexcept
	Returns true if the UI element is selectable.

bool	isSelected () const noexcept
	Returns true if the UI element is selected.

AccessibleState	withAccessibleOffscreen () const noexcept
	Sets the accessible offscreen flag and returns the new state.

AccessibleState	withCheckable () const noexcept
	Sets the checkable flag and returns the new state.

AccessibleState	withChecked () const noexcept
	Sets the checked flag and returns the new state.

AccessibleState	withCollapsed () const noexcept
	Sets the collapsed flag and returns the new state.

AccessibleState	withExpandable () const noexcept
	Sets the expandable flag and returns the new state.

AccessibleState	withExpanded () const noexcept
	Sets the expanded flag and returns the new state.

AccessibleState	withFocusable () const noexcept
	Sets the focusable flag and returns the new state.

AccessibleState	withFocused () const noexcept
	Sets the focused flag and returns the new state.

AccessibleState	withIgnored () const noexcept
	Sets the ignored flag and returns the new state.

AccessibleState	withMultiSelectable () const noexcept
	Sets the multiSelectable flag and returns the new state.

AccessibleState	withSelectable () const noexcept
	Sets the selectable flag and returns the new state.

AccessibleState	withSelected () const noexcept
	Sets the selected flag and returns the new state.

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

AccessibleState	withFlag (int flag) const noexcept

Private Attributes
int	flags = 0

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

@tags{Accessibility}

Member Enumeration Documentation

◆ Flags

enum juce::AccessibleState::Flags

private

Enumerator
checkable
checked
collapsed
expandable
expanded
focusable
focused
ignored
multiSelectable
selectable
selected
accessibleOffscreen

Constructor & Destructor Documentation

◆ AccessibleState()

juce::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

◆ isAccessibleOffscreen()

bool juce::AccessibleState::isAccessibleOffscreen ( ) const

inlinenoexcept

Returns true if the UI element is accessible offscreen.

See also: withSelected

◆ isCheckable()

bool juce::AccessibleState::isCheckable ( ) const

inlinenoexcept

Returns true if the UI element is checkable.

See also: withCheckable

◆ isChecked()

bool juce::AccessibleState::isChecked ( ) const

inlinenoexcept

Returns true if the UI element is checked.

See also: withChecked

Referenced by juce::UIAToggleProvider::getCurrentToggleState().

◆ isCollapsed()

bool juce::AccessibleState::isCollapsed ( ) const

inlinenoexcept

Returns true if the UI element is collapsed.

See also: withCollapsed

◆ isExpandable()

bool juce::AccessibleState::isExpandable ( ) const

inlinenoexcept

Returns true if the UI element is expandable.

See also: withExpandable

◆ isExpanded()

bool juce::AccessibleState::isExpanded ( ) const

inlinenoexcept

Returns true if the UI element is expanded.

See also: withExpanded

Referenced by juce::UIAExpandCollapseProvider::get_ExpandCollapseState().

◆ isFlagSet()

bool juce::AccessibleState::isFlagSet ( int flag ) const

inlineprivatenoexcept

◆ isFocusable()

bool juce::AccessibleState::isFocusable ( ) const

inlinenoexcept

Returns true if the UI element is focusable.

See also: withFocusable

◆ isFocused()

bool juce::AccessibleState::isFocused ( ) const

inlinenoexcept

Returns true if the UI element is focused.

See also: withFocused

◆ isIgnored()

bool juce::AccessibleState::isIgnored ( ) const

inlinenoexcept

Returns true if the UI element is ignored.

See also: withIgnored

◆ isMultiSelectable()

bool juce::AccessibleState::isMultiSelectable ( ) const

inlinenoexcept

Returns true if the UI element supports multiple item selection.

See also: withMultiSelectable

Referenced by juce::UIASelectionProvider::isMultiSelectable().

◆ isSelectable()

bool juce::AccessibleState::isSelectable ( ) const

inlinenoexcept

Returns true if the UI element is selectable.

See also: withSelectable

◆ isSelected()

bool juce::AccessibleState::isSelected ( ) const

inlinenoexcept

Returns true if the UI element is selected.

See also: withSelected

◆ withAccessibleOffscreen()

AccessibleState juce::AccessibleState::withAccessibleOffscreen ( ) const

inlinenoexcept

Sets the accessible offscreen flag and returns the new state.

See also: isSelected

◆ withCheckable()

AccessibleState juce::AccessibleState::withCheckable ( ) const

inlinenoexcept

Sets the checkable flag and returns the new state.

See also: isCheckable

◆ withChecked()

AccessibleState juce::AccessibleState::withChecked ( ) const

inlinenoexcept

Sets the checked flag and returns the new state.

See also: isChecked

◆ withCollapsed()

AccessibleState juce::AccessibleState::withCollapsed ( ) const

inlinenoexcept

Sets the collapsed flag and returns the new state.

See also: isCollapsed

◆ withExpandable()

AccessibleState juce::AccessibleState::withExpandable ( ) const

inlinenoexcept

Sets the expandable flag and returns the new state.

See also: isExpandable

◆ withExpanded()

AccessibleState juce::AccessibleState::withExpanded ( ) const

inlinenoexcept

Sets the expanded flag and returns the new state.

See also: isExpanded

◆ withFlag()

AccessibleState juce::AccessibleState::withFlag ( int flag ) const

inlineprivatenoexcept

◆ withFocusable()

AccessibleState juce::AccessibleState::withFocusable ( ) const

inlinenoexcept

Sets the focusable flag and returns the new state.

See also: isFocusable

◆ withFocused()

AccessibleState juce::AccessibleState::withFocused ( ) const

inlinenoexcept

Sets the focused flag and returns the new state.

See also: isFocused

◆ withIgnored()

AccessibleState juce::AccessibleState::withIgnored ( ) const

inlinenoexcept

Sets the ignored flag and returns the new state.

See also: isIgnored

◆ withMultiSelectable()

AccessibleState juce::AccessibleState::withMultiSelectable ( ) const

inlinenoexcept

Sets the multiSelectable flag and returns the new state.

See also: isMultiSelectable

◆ withSelectable()

AccessibleState juce::AccessibleState::withSelectable ( ) const

inlinenoexcept

Sets the selectable flag and returns the new state.

See also: isSelectable

◆ withSelected()

AccessibleState juce::AccessibleState::withSelected ( ) const

inlinenoexcept

Sets the selected flag and returns the new state.

See also: isSelected

Member Data Documentation

◆ flags

int juce::AccessibleState::flags = 0

private

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

juce_AccessibilityState.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ AccessibleState()

Member Function Documentation

◆ isAccessibleOffscreen()

◆ isCheckable()

◆ isChecked()

◆ isCollapsed()

◆ isExpandable()

◆ isExpanded()

◆ isFlagSet()

◆ isFocusable()

◆ isFocused()

◆ isIgnored()

◆ isMultiSelectable()

◆ isSelectable()

◆ isSelected()

◆ withAccessibleOffscreen()

◆ withCheckable()

◆ withChecked()

◆ withCollapsed()

◆ withExpandable()

◆ withExpanded()

◆ withFlag()

◆ withFocusable()

◆ withFocused()

◆ withIgnored()

◆ withMultiSelectable()

◆ withSelectable()

◆ withSelected()

Member Data Documentation

◆ flags