#include <juce_ValueTreePropertyWithDefault.h>
Public Attributes | |
std::function< void()> | onDefaultChange |
This class acts as a wrapper around a property inside a ValueTree.
If the property inside the ValueTree is missing it will return a default value, which can be specified in the constructor or by calling setDefault().
Definition at line 38 of file juce_ValueTreePropertyWithDefault.h.
|
default |
Creates an uninitialised ValueTreePropertyWithDefault object.
Initialise it using one of the referTo() methods.
Referenced by operator=(), and ValueTreePropertyWithDefault().
|
inline |
Creates a ValueTreePropertyWithDefault object for the specified property.
The default value will be an empty var.
Definition at line 52 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Creates an ValueTreePropertyWithDefault object for the specified property.
The default value will be defaultToUse.
Definition at line 63 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Creates a ValueTreePropertyWithDefault object for the specified property.
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 79 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Creates a ValueTreePropertyWithDefault object from another ValueTreePropertyWithDefault object.
Definition at line 89 of file juce_ValueTreePropertyWithDefault.h.
|
inlineoverride |
Destructor.
Definition at line 99 of file juce_ValueTreePropertyWithDefault.h.
|
inlinenoexcept |
Returns the current value of the property.
If the property does not exist this returns the default value.
Definition at line 109 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Returns the current default value.
Definition at line 124 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Returns the current property as a Value object.
Definition at line 121 of file juce_ValueTreePropertyWithDefault.h.
|
inlinenoexcept |
Returns the property ID of the referenced property.
Definition at line 222 of file juce_ValueTreePropertyWithDefault.h.
|
inlinenoexcept |
Returns the UndoManager that is being used.
Definition at line 225 of file juce_ValueTreePropertyWithDefault.h.
|
inlinenoexcept |
Returns a reference to the ValueTree containing the referenced property.
Definition at line 219 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Returns true if the property does not exist in the referenced ValueTree.
Definition at line 130 of file juce_ValueTreePropertyWithDefault.h.
Referenced by get().
|
inline |
Definition at line 228 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Sets the property and returns the new ValueTreePropertyWithDefault.
This will modify the property in the referenced ValueTree.
Definition at line 147 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.
The default value will be an empty var.
Definition at line 171 of file juce_ValueTreePropertyWithDefault.h.
Referenced by ValueTreePropertyWithDefault(), ValueTreePropertyWithDefault(), and ValueTreePropertyWithDefault().
|
inline |
Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.
The default value will be defaultVal.
Definition at line 187 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Makes the ValueTreePropertyWithDefault refer to the specified property inside the given ValueTree.
The default value will be defaultVal.
Definition at line 204 of file juce_ValueTreePropertyWithDefault.h.
|
inlinenoexcept |
Removes the property from the referenced ValueTree.
Definition at line 133 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Sets the default value to a new var.
Definition at line 127 of file juce_ValueTreePropertyWithDefault.h.
|
inline |
Sets the property.
This will modify the property in the referenced ValueTree.
Definition at line 157 of file juce_ValueTreePropertyWithDefault.h.
Referenced by operator=().
std::function<void()> juce::ValueTreePropertyWithDefault::onDefaultChange |
You can assign a lambda to this callback and it will called when the default value is changed.
Definition at line 140 of file juce_ValueTreePropertyWithDefault.h.