JUCE  v6.1.6 (6.0.8-1114)
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::AccessibilityValueInterface Class Referenceabstract

An abstract interface representing the value of an accessibility element. More...

#include <juce_AccessibilityValueInterface.h>

Inheritance diagram for juce::AccessibilityValueInterface:

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...
 

Detailed Description

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.

See also
AccessibilityTextValueInterface, AccessibilityNumericValueInterface, AccessibilityRangedNumericValueInterface

@tags{Accessibility}

Constructor & Destructor Documentation

◆ ~AccessibilityValueInterface()

virtual juce::AccessibilityValueInterface::~AccessibilityValueInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getCurrentValue()

virtual double juce::AccessibilityValueInterface::getCurrentValue ( ) const
pure virtual

◆ getCurrentValueAsString()

virtual String juce::AccessibilityValueInterface::getCurrentValueAsString ( ) const
pure virtual

◆ getRange()

virtual AccessibleValueRange juce::AccessibilityValueInterface::getRange ( ) const
pure virtual

◆ isReadOnly()

virtual bool juce::AccessibilityValueInterface::isReadOnly ( ) const
pure virtual

◆ setValue()

virtual void juce::AccessibilityValueInterface::setValue ( double  newValue)
pure virtual

◆ setValueAsString()

virtual void juce::AccessibilityValueInterface::setValueAsString ( const String newValue)
pure virtual

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