juce_AccessibilityValueInterface.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{

class JUCE_API  AccessibilityValueInterface
{
public:
    virtual ~AccessibilityValueInterface() = default;

    virtual bool isReadOnly() const = 0;

    virtual double getCurrentValue() const = 0;

    virtual String getCurrentValueAsString() const = 0;

    virtual void setValue (double newValue) = 0;

    virtual void setValueAsString (const String& newValue) = 0;

    class JUCE_API  AccessibleValueRange
    {
    public:
        AccessibleValueRange() = default;

        struct JUCE_API  MinAndMax  { double min, max; };

        AccessibleValueRange (MinAndMax valueRange, double interval)
            : valid (true),
              range (valueRange),
              stepSize (interval)
        {
            jassert (range.min < range.max);
        }

        bool isValid() const noexcept            { return valid; }

        double getMinimumValue() const noexcept  { return range.min; }

        double getMaximumValue() const noexcept  { return range.max; }

        double getInterval() const noexcept      { return stepSize; }
 
    private:
        bool valid = false;
        MinAndMax range {};
        double stepSize = 0.0;
    };

    virtual AccessibleValueRange getRange() const = 0;
};
 
//==============================================================================
class JUCE_API  AccessibilityTextValueInterface  : public AccessibilityValueInterface
{
public:
    bool isReadOnly() const override = 0;

    String getCurrentValueAsString() const override = 0;

    void setValueAsString (const String& newValue) override = 0;

    double getCurrentValue() const final         { return getCurrentValueAsString().getDoubleValue(); }
    void setValue (double newValue) final        { setValueAsString (String (newValue)); }
    AccessibleValueRange getRange() const final  { return {}; }
};
 
//==============================================================================
class JUCE_API  AccessibilityNumericValueInterface  : public AccessibilityValueInterface
{
public:
    bool isReadOnly() const override = 0;

    double getCurrentValue() const override = 0;

    void setValue (double newValue) override = 0;

    String getCurrentValueAsString() const final          { return String (getCurrentValue()); }
    void setValueAsString (const String& newValue) final  { setValue (newValue.getDoubleValue()); }
    AccessibleValueRange getRange() const final           { return {}; }
};
 
//==============================================================================
class JUCE_API  AccessibilityRangedNumericValueInterface  : public AccessibilityValueInterface
{
public:
    bool isReadOnly() const override = 0;

    double getCurrentValue() const override = 0;

    void setValue (double newValue) override = 0;

    AccessibleValueRange getRange() const override = 0;

    String getCurrentValueAsString() const final          { return String (getCurrentValue()); }
    void setValueAsString (const String& newValue) final  { setValue (newValue.getDoubleValue()); }
};
 
} // namespace juce