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

#include "juce_AccessibilityState.h"

Public Member Functions
	AccessibleState ()=default
	Constructor.

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	withSelectable () const noexcept
	Sets the selectable flag and returns the new state.

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

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

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

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.

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

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}

Definition at line 38 of file juce_AccessibilityState.h.

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

noexcept

Returns true if the UI element is accessible offscreen.

See also: withSelected

Definition at line 192 of file juce_AccessibilityState.h.

◆ isCheckable()

bool juce::AccessibleState::isCheckable ( ) const

noexcept

Returns true if the UI element is checkable.

See also: withCheckable

Definition at line 126 of file juce_AccessibilityState.h.

◆ isChecked()

bool juce::AccessibleState::isChecked ( ) const

noexcept

Returns true if the UI element is checked.

See also: withChecked

Definition at line 132 of file juce_AccessibilityState.h.

◆ isCollapsed()

bool juce::AccessibleState::isCollapsed ( ) const

noexcept

Returns true if the UI element is collapsed.

See also: withCollapsed

Definition at line 138 of file juce_AccessibilityState.h.

◆ isExpandable()

bool juce::AccessibleState::isExpandable ( ) const

noexcept

Returns true if the UI element is expandable.

See also: withExpandable

Definition at line 144 of file juce_AccessibilityState.h.

◆ isExpanded()

bool juce::AccessibleState::isExpanded ( ) const

noexcept

Returns true if the UI element is expanded.

See also: withExpanded

Definition at line 150 of file juce_AccessibilityState.h.

◆ isFocusable()

bool juce::AccessibleState::isFocusable ( ) const

noexcept

Returns true if the UI element is focusable.

See also: withFocusable

Definition at line 156 of file juce_AccessibilityState.h.

◆ isFocused()

bool juce::AccessibleState::isFocused ( ) const

noexcept

Returns true if the UI element is focused.

See also: withFocused

Definition at line 162 of file juce_AccessibilityState.h.

◆ isIgnored()

bool juce::AccessibleState::isIgnored ( ) const

noexcept

Returns true if the UI element is ignored.

See also: withIgnored

Definition at line 168 of file juce_AccessibilityState.h.

◆ isMultiSelectable()

bool juce::AccessibleState::isMultiSelectable ( ) const

noexcept

Returns true if the UI element supports multiple item selection.

See also: withMultiSelectable

Definition at line 174 of file juce_AccessibilityState.h.

◆ isSelectable()

bool juce::AccessibleState::isSelectable ( ) const

noexcept

Returns true if the UI element is selectable.

See also: withSelectable

Definition at line 180 of file juce_AccessibilityState.h.

◆ isSelected()

bool juce::AccessibleState::isSelected ( ) const

noexcept

Returns true if the UI element is selected.

See also: withSelected

Definition at line 186 of file juce_AccessibilityState.h.

◆ withAccessibleOffscreen()

AccessibleState juce::AccessibleState::withAccessibleOffscreen ( ) const

noexcept

Sets the accessible offscreen flag and returns the new state.

See also: isSelected

Definition at line 119 of file juce_AccessibilityState.h.

◆ withCheckable()

AccessibleState juce::AccessibleState::withCheckable ( ) const

noexcept

Sets the checkable flag and returns the new state.

See also: isCheckable

Definition at line 53 of file juce_AccessibilityState.h.

◆ withChecked()

AccessibleState juce::AccessibleState::withChecked ( ) const

noexcept

Sets the checked flag and returns the new state.

See also: isChecked

Definition at line 59 of file juce_AccessibilityState.h.

◆ withCollapsed()

AccessibleState juce::AccessibleState::withCollapsed ( ) const

noexcept

Sets the collapsed flag and returns the new state.

See also: isCollapsed

Definition at line 65 of file juce_AccessibilityState.h.

◆ withExpandable()

AccessibleState juce::AccessibleState::withExpandable ( ) const

noexcept

Sets the expandable flag and returns the new state.

See also: isExpandable

Definition at line 71 of file juce_AccessibilityState.h.

◆ withExpanded()

AccessibleState juce::AccessibleState::withExpanded ( ) const

noexcept

Sets the expanded flag and returns the new state.

See also: isExpanded

Definition at line 77 of file juce_AccessibilityState.h.

◆ withFocusable()

AccessibleState juce::AccessibleState::withFocusable ( ) const

noexcept

Sets the focusable flag and returns the new state.

See also: isFocusable

Definition at line 83 of file juce_AccessibilityState.h.

◆ withFocused()

AccessibleState juce::AccessibleState::withFocused ( ) const

noexcept

Sets the focused flag and returns the new state.

See also: isFocused

Definition at line 89 of file juce_AccessibilityState.h.

◆ withIgnored()

AccessibleState juce::AccessibleState::withIgnored ( ) const

noexcept

Sets the ignored flag and returns the new state.

See also: isIgnored

Definition at line 95 of file juce_AccessibilityState.h.

◆ withMultiSelectable()

AccessibleState juce::AccessibleState::withMultiSelectable ( ) const

noexcept

Sets the multiSelectable flag and returns the new state.

See also: isMultiSelectable

Definition at line 107 of file juce_AccessibilityState.h.

◆ withSelectable()

AccessibleState juce::AccessibleState::withSelectable ( ) const

noexcept

Sets the selectable flag and returns the new state.

See also: isSelectable

Definition at line 101 of file juce_AccessibilityState.h.

◆ withSelected()

AccessibleState juce::AccessibleState::withSelected ( ) const

noexcept

Sets the selected flag and returns the new state.

See also: isSelected

Definition at line 113 of file juce_AccessibilityState.h.

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

juce_gui_basics/accessibility/juce_AccessibilityState.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleState()

Member Function Documentation

◆ isAccessibleOffscreen()

◆ isCheckable()

◆ isChecked()

◆ isCollapsed()

◆ isExpandable()

◆ isExpanded()

◆ isFocusable()

◆ isFocused()

◆ isIgnored()

◆ isMultiSelectable()

◆ isSelectable()

◆ isSelected()

◆ withAccessibleOffscreen()

◆ withCheckable()

◆ withChecked()

◆ withCollapsed()

◆ withExpandable()

◆ withExpanded()

◆ withFocusable()

◆ withFocused()

◆ withIgnored()

◆ withMultiSelectable()

◆ withSelectable()

◆ withSelected()