OpenShot Library | OpenShotAudio 0.2.2
juce::ValueWithDefault Class Reference

This class acts as a wrapper around a property inside a ValueTree. More...

#include <juce_ValueWithDefault.h>

Public Member Functions

 ValueWithDefault ()=default
 Creates an unitialised ValueWithDefault. More...
 
 ValueWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um)
 Creates an ValueWithDefault object. More...
 
 ValueWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um, const var &defaultToUse)
 Creates an ValueWithDefault object. More...
 
 ValueWithDefault (ValueTree &tree, const Identifier &propertyID, UndoManager *um, const var &defaultToUse, StringRef arrayDelimiter)
 Creates an ValueWithDefault object. More...
 
 ValueWithDefault (const ValueWithDefault &other)
 Creates a ValueWithDefault object from another ValueWithDefault object. More...
 
var get () const noexcept
 Returns the current value of the property. More...
 
Value getPropertyAsValue ()
 Returns the current property as a Value object. More...
 
var getDefault () const
 Returns the current default value. More...
 
void setDefault (const var &newDefault)
 Sets the default value to a new var. More...
 
bool isUsingDefault () const
 Returns true if the property does not exist in the referenced ValueTree. More...
 
void resetToDefault () noexcept
 Removes the property from the referenced ValueTree. More...
 
ValueWithDefaultoperator= (const var &newValue)
 Sets the property and returns the new ValueWithDefault. More...
 
void setValue (const var &newValue, UndoManager *undoManagerToUse)
 Sets the property. More...
 
void referTo (ValueTree &tree, const Identifier &property, UndoManager *um)
 Makes the ValueWithDefault refer to the specified property inside the given ValueTree. More...
 
void referTo (ValueTree &tree, const Identifier &property, UndoManager *um, const var &defaultVal)
 Makes the ValueWithDefault refer to the specified property inside the given ValueTree, and specifies a default value to use. More...
 
void referTo (ValueTree &tree, const Identifier &property, UndoManager *um, const var &defaultVal, StringRef arrayDelimiter)
 
ValueTreegetValueTree () noexcept
 Returns a reference to the ValueTree containing the referenced property. More...
 
IdentifiergetPropertyID () noexcept
 Returns the property ID of the referenced property. More...
 
UndoManagergetUndoManager () noexcept
 Returns the UndoManager that is being used. More...
 
ValueWithDefaultoperator= (const ValueWithDefault &other)
 

Public Attributes

std::function< void()> onDefaultChange
 You can assign a lambda to this callback object to have it called when the default value is changed. More...
 

Detailed Description

This class acts as a wrapper around a property inside a ValueTree.

If the property inside the ValueTree is missing or empty the ValueWithDefault will automatically return a default value, which can be specified when initialising the ValueWithDefault.

Definition at line 43 of file juce_ValueWithDefault.h.

Constructor & Destructor Documentation

◆ ValueWithDefault() [1/5]

juce::ValueWithDefault::ValueWithDefault ( )
default

Creates an unitialised ValueWithDefault.

Initialise it using one of the referTo() methods.

◆ ValueWithDefault() [2/5]

juce::ValueWithDefault::ValueWithDefault ( ValueTree tree,
const Identifier propertyID,
UndoManager um 
)
inline

Creates an ValueWithDefault object.

The default value will be an empty var.

Definition at line 51 of file juce_ValueWithDefault.h.

◆ ValueWithDefault() [3/5]

juce::ValueWithDefault::ValueWithDefault ( ValueTree tree,
const Identifier propertyID,
UndoManager um,
const var defaultToUse 
)
inline

Creates an ValueWithDefault object.

The default value will be defaultToUse.

Definition at line 60 of file juce_ValueWithDefault.h.

◆ ValueWithDefault() [4/5]

juce::ValueWithDefault::ValueWithDefault ( ValueTree tree,
const Identifier propertyID,
UndoManager um,
const var defaultToUse,
StringRef  arrayDelimiter 
)
inline

Creates an ValueWithDefault object.

The default value will be defaultToUse.

Use this constructor if the underlying var object being controlled is an array and it will handle the conversion to/from a delimited String that can be written to XML format.

Definition at line 75 of file juce_ValueWithDefault.h.

◆ ValueWithDefault() [5/5]

juce::ValueWithDefault::ValueWithDefault ( const ValueWithDefault other)
inline

Creates a ValueWithDefault object from another ValueWithDefault object.

Definition at line 86 of file juce_ValueWithDefault.h.

Member Function Documentation

◆ get()

var juce::ValueWithDefault::get ( ) const
inlinenoexcept

Returns the current value of the property.

If the property does not exist or is empty, returns the default value.

Definition at line 99 of file juce_ValueWithDefault.h.

References juce::String::isNotEmpty(), and isUsingDefault().

◆ getPropertyAsValue()

Value juce::ValueWithDefault::getPropertyAsValue ( )
inline

Returns the current property as a Value object.

Definition at line 111 of file juce_ValueWithDefault.h.

References juce::ValueTree::getPropertyAsValue().

◆ getDefault()

var juce::ValueWithDefault::getDefault ( ) const
inline

Returns the current default value.

Definition at line 114 of file juce_ValueWithDefault.h.

◆ setDefault()

void juce::ValueWithDefault::setDefault ( const var newDefault)
inline

Sets the default value to a new var.

Definition at line 117 of file juce_ValueWithDefault.h.

References onDefaultChange.

◆ isUsingDefault()

bool juce::ValueWithDefault::isUsingDefault ( ) const
inline

Returns true if the property does not exist in the referenced ValueTree.

Definition at line 129 of file juce_ValueWithDefault.h.

References juce::ValueTree::hasProperty().

Referenced by get().

◆ resetToDefault()

void juce::ValueWithDefault::resetToDefault ( )
inlinenoexcept

Removes the property from the referenced ValueTree.

Definition at line 135 of file juce_ValueWithDefault.h.

References juce::ValueTree::removeProperty().

◆ operator=() [1/2]

ValueWithDefault & juce::ValueWithDefault::operator= ( const var newValue)
inline

Sets the property and returns the new ValueWithDefault.

This will modify the property in the referenced ValueTree.

Definition at line 145 of file juce_ValueWithDefault.h.

References setValue().

◆ setValue()

void juce::ValueWithDefault::setValue ( const var newValue,
UndoManager undoManagerToUse 
)
inline

Sets the property.

This will actually modify the property in the referenced ValueTree.

Definition at line 152 of file juce_ValueWithDefault.h.

References juce::var::getArray(), and juce::ValueTree::setProperty().

Referenced by operator=().

◆ referTo() [1/3]

void juce::ValueWithDefault::referTo ( ValueTree tree,
const Identifier property,
UndoManager um 
)
inline

Makes the ValueWithDefault refer to the specified property inside the given ValueTree.

Definition at line 162 of file juce_ValueWithDefault.h.

◆ referTo() [2/3]

void juce::ValueWithDefault::referTo ( ValueTree tree,
const Identifier property,
UndoManager um,
const var defaultVal 
)
inline

Makes the ValueWithDefault refer to the specified property inside the given ValueTree, and specifies a default value to use.

Definition at line 170 of file juce_ValueWithDefault.h.

◆ referTo() [3/3]

void juce::ValueWithDefault::referTo ( ValueTree tree,
const Identifier property,
UndoManager um,
const var defaultVal,
StringRef  arrayDelimiter 
)
inline

Definition at line 175 of file juce_ValueWithDefault.h.

◆ getValueTree()

ValueTree & juce::ValueWithDefault::getValueTree ( )
inlinenoexcept

Returns a reference to the ValueTree containing the referenced property.

Definition at line 183 of file juce_ValueWithDefault.h.

◆ getPropertyID()

Identifier & juce::ValueWithDefault::getPropertyID ( )
inlinenoexcept

Returns the property ID of the referenced property.

Definition at line 186 of file juce_ValueWithDefault.h.

◆ getUndoManager()

UndoManager * juce::ValueWithDefault::getUndoManager ( )
inlinenoexcept

Returns the UndoManager that is being used.

Definition at line 189 of file juce_ValueWithDefault.h.

◆ operator=() [2/2]

ValueWithDefault & juce::ValueWithDefault::operator= ( const ValueWithDefault other)
inline

Definition at line 192 of file juce_ValueWithDefault.h.

Member Data Documentation

◆ onDefaultChange

std::function<void()> juce::ValueWithDefault::onDefaultChange

You can assign a lambda to this callback object to have it called when the default value is changed.

Definition at line 141 of file juce_ValueWithDefault.h.

Referenced by setDefault().


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