juce::AccessibilityValueInterface::AccessibleValueRange Class Reference

Represents the range of this value, if supported. More...

#include <juce_AccessibilityValueInterface.h>

Collaboration diagram for juce::AccessibilityValueInterface::AccessibleValueRange:

Classes
struct	MinAndMax
	The minimum and maximum values for this range, inclusive. More...

Public Member Functions
	AccessibleValueRange ()=default
	Constructor. More...
	AccessibleValueRange (MinAndMax valueRange, double interval)
	Constructor. More...
double	getInterval () const noexcept
	Returns the interval for this range. More...
double	getMaximumValue () const noexcept
	Returns the maximum value for this range. More...
double	getMinimumValue () const noexcept
	Returns the minimum value for this range. More...
bool	isValid () const noexcept
	Returns true if this represents a valid range. More...

Private Attributes
MinAndMax	range {}
double	stepSize = 0.0
bool	valid = false

Detailed Description

Represents the range of this value, if supported.

Return one of these from the getRange() method, providing a minimum, maximum, and interval value for the range to indicate that this is a ranged value.

The default state is an "invalid" range, indicating that the accessibility element does not support ranged values.

See also

AccessibilityRangedNumericValueInterface

@tags{Accessibility}

Constructor & Destructor Documentation

AccessibleValueRange() [1/2]

juce::AccessibilityValueInterface::AccessibleValueRange::AccessibleValueRange ( )

default

Constructor.

Creates a default, "invalid" range that can be returned from AccessibilityValueInterface::getRange() to indicate that the value interface does not support ranged values.

AccessibleValueRange() [2/2]

juce::AccessibilityValueInterface::AccessibleValueRange::AccessibleValueRange ( MinAndMax  valueRange, double  interval  )

inline

Constructor.

Creates a valid AccessibleValueRange with the provided minimum, maximum, and interval values.

References jassert, and juce::gl::range.

Member Function Documentation

getInterval()

double juce::AccessibilityValueInterface::AccessibleValueRange::getInterval ( ) const

inlinenoexcept

Returns the interval for this range.

getMaximumValue()

double juce::AccessibilityValueInterface::AccessibleValueRange::getMaximumValue ( ) const

inlinenoexcept

Returns the maximum value for this range.

References juce::gl::range.

getMinimumValue()

double juce::AccessibilityValueInterface::AccessibleValueRange::getMinimumValue ( ) const

inlinenoexcept

Returns the minimum value for this range.

References juce::gl::range.

isValid()

bool juce::AccessibilityValueInterface::AccessibleValueRange::isValid ( ) const

inlinenoexcept

Returns true if this represents a valid range.

Member Data Documentation

range

MinAndMax juce::AccessibilityValueInterface::AccessibleValueRange::range {}

private

stepSize

double juce::AccessibilityValueInterface::AccessibleValueRange::stepSize = 0.0

private

valid

bool juce::AccessibilityValueInterface::AccessibleValueRange::valid = false

private

---

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

• juce_AccessibilityValueInterface.h