An abstract interface representing the value of an accessibility element. More...
#include <juce_AccessibilityValueInterface.h>
Classes | |
class | AccessibleValueRange |
Represents the range of this value, if supported. More... | |
Public Member Functions | |
virtual | ~AccessibilityValueInterface ()=default |
Destructor. More... | |
virtual double | getCurrentValue () const =0 |
Returns the current value as a double. More... | |
virtual String | getCurrentValueAsString () const =0 |
Returns the current value as a String. More... | |
virtual AccessibleValueRange | getRange () const =0 |
If this is a ranged value, this should return a valid AccessibleValueRange object representing the supported numerical range. More... | |
virtual bool | isReadOnly () const =0 |
Returns true if the value is read-only and cannot be modified by an accessibility client. More... | |
virtual void | setValue (double newValue)=0 |
Sets the current value to a new double value. More... | |
virtual void | setValueAsString (const String &newValue)=0 |
Sets the current value to a new String value. More... | |
An abstract interface representing the value of an accessibility element.
Values should be used when information needs to be conveyed which cannot be represented by the accessibility element's label alone. For example, a gain slider with the label "Gain" needs to also provide a value for its position whereas a "Save" button does not.
This class allows for full control over the value text/numeric conversion, ranged, and read-only properties but in most cases you'll want to use one of the derived classes below which handle some of this for you.
@tags{Accessibility}
|
virtualdefault |
Destructor.
|
pure virtual |
Returns the current value as a double.
Implemented in juce::AccessibilityRangedNumericValueInterface, juce::AccessibilityNumericValueInterface, and juce::AccessibilityTextValueInterface.
Referenced by juce::UIARangeValueProvider::get_Value().
|
pure virtual |
Returns the current value as a String.
Implemented in juce::AccessibilityTextValueInterface, juce::AccessibilityRangedNumericValueInterface, and juce::AccessibilityNumericValueInterface.
Referenced by juce::UIAValueProvider::get_Value().
|
pure virtual |
If this is a ranged value, this should return a valid AccessibleValueRange object representing the supported numerical range.
Implemented in juce::AccessibilityRangedNumericValueInterface, juce::AccessibilityNumericValueInterface, and juce::AccessibilityTextValueInterface.
Referenced by juce::UIARangeValueProvider::get_Maximum(), juce::UIARangeValueProvider::get_Minimum(), and juce::UIARangeValueProvider::get_SmallChange().
|
pure virtual |
Returns true if the value is read-only and cannot be modified by an accessibility client.
Implemented in juce::AccessibilityRangedNumericValueInterface, juce::AccessibilityNumericValueInterface, and juce::AccessibilityTextValueInterface.
Referenced by juce::UIAValueProvider::get_IsReadOnly(), and juce::UIARangeValueProvider::get_IsReadOnly().
|
pure virtual |
Sets the current value to a new double value.
Implemented in juce::AccessibilityRangedNumericValueInterface, juce::AccessibilityNumericValueInterface, and juce::AccessibilityTextValueInterface.
|
pure virtual |
Sets the current value to a new String value.
Implemented in juce::AccessibilityTextValueInterface, juce::AccessibilityRangedNumericValueInterface, and juce::AccessibilityNumericValueInterface.