OpenShot Library | OpenShotAudio
0.2.1
|
This class acts as a typed wrapper around a property inside a ValueTree. More...
#include <juce_CachedValue.h>
Public Member Functions | |
CachedValue () | |
Default constructor. More... | |
CachedValue (ValueTree &tree, const Identifier &propertyID, UndoManager *undoManager) | |
Constructor. More... | |
CachedValue (ValueTree &tree, const Identifier &propertyID, UndoManager *undoManager, const Type &defaultToUse) | |
Constructor. More... | |
operator Type () const noexcept | |
Returns the current value of the property. More... | |
Type | get () const noexcept |
Returns the current value of the property. More... | |
Type & | operator* () noexcept |
Dereference operator. More... | |
Type * | operator-> () noexcept |
Dereference operator. More... | |
template<typename OtherType > | |
bool | operator== (const OtherType &other) const |
Returns true if the current value of the property (or the fallback value) is equal to other. | |
template<typename OtherType > | |
bool | operator!= (const OtherType &other) const |
Returns true if the current value of the property (or the fallback value) is not equal to other. | |
Value | getPropertyAsValue () |
Returns the current property as a Value object. More... | |
bool | isUsingDefault () const |
Returns true if the current property does not exist and the CachedValue is using the fallback default value instead. | |
Type | getDefault () const |
Returns the current fallback default value. More... | |
CachedValue & | operator= (const Type &newValue) |
Sets the property. More... | |
void | setValue (const Type &newValue, UndoManager *undoManagerToUse) |
Sets the property. More... | |
void | resetToDefault () |
Removes the property from the referenced ValueTree and makes the CachedValue return the fallback default value instead. | |
void | resetToDefault (UndoManager *undoManagerToUse) |
Removes the property from the referenced ValueTree and makes the CachedValue return the fallback default value instead. | |
void | setDefault (const Type &value) |
Resets the fallback default value. More... | |
void | referTo (ValueTree &tree, const Identifier &property, UndoManager *um) |
Makes the CachedValue refer to the specified property inside the given ValueTree. More... | |
void | referTo (ValueTree &tree, const Identifier &property, UndoManager *um, const Type &defaultVal) |
Makes the CachedValue refer to the specified property inside the given ValueTree, and specifies a fallback value to use if the property does not exist. | |
void | forceUpdateOfCachedValue () |
Force an update in case the referenced property has been changed from elsewhere. More... | |
ValueTree & | getValueTree () noexcept |
Returns a reference to the ValueTree containing the referenced property. More... | |
const Identifier & | getPropertyID () const noexcept |
Returns the property ID of the referenced property. More... | |
UndoManager * | getUndoManager () noexcept |
Returns the UndoManager that is being used. More... | |
This class acts as a typed wrapper around a property inside a ValueTree.
A CachedValue provides an easy way to read and write a ValueTree property with a chosen type. So for example a CachedValue<int> allows you to read or write the property as an int, and a CachedValue<String> lets you work with it as a String.
It also allows efficient access to the value, by caching a copy of it in the type that is being used.
You can give the CachedValue an optional UndoManager which it will use when writing to the underlying ValueTree.
If the property inside the ValueTree is missing, the CachedValue will automatically return an optional default value, which can be specified when initialising the CachedValue.
To create one, you can either use the constructor to attach the CachedValue to a ValueTree, or can create an uninitialised CachedValue with its default constructor and then attach it later with the referTo() methods.
Common types like String, int, double which can be easily converted to a var should work out-of-the-box, but if you want to use more complex custom types, you may need to implement some template specialisations of VariantConverter which this class uses to convert between the type and the ValueTree's internal var.
Definition at line 63 of file juce_CachedValue.h.
|
inlinedefault |
Default constructor.
Creates a default CachedValue not referring to any property. To initialise the object, call one of the referTo() methods.
Referenced by juce::CachedValue< Type >::getUndoManager().
|
inline |
Constructor.
Creates a CachedValue referring to a Value property inside a ValueTree. If you use this constructor, the fallback value will be a default-constructed instance of Type.
tree | The ValueTree containing the property |
propertyID | The identifier of the property |
undoManager | The UndoManager to use when writing to the property |
Definition at line 216 of file juce_CachedValue.h.
References juce::ValueTree::addListener().
|
inline |
Constructor.
Creates a default Cached Value referring to a Value property inside a ValueTree, and specifies a fallback value to use if the property does not exist.
tree | The ValueTree containing the property |
propertyID | The identifier of the property |
undoManager | The UndoManager to use when writing to the property |
defaultToUse | The fallback default value to use. |
Definition at line 224 of file juce_CachedValue.h.
References juce::ValueTree::addListener().
|
inlinenoexcept |
Returns the current value of the property.
If the property does not exist, returns the fallback default value.
This is the same as calling get().
Definition at line 105 of file juce_CachedValue.h.
|
inlinenoexcept |
Returns the current value of the property.
If the property does not exist, returns the fallback default value.
Definition at line 110 of file juce_CachedValue.h.
|
inlinenoexcept |
Dereference operator.
Provides direct access to the property.
Definition at line 113 of file juce_CachedValue.h.
|
inlinenoexcept |
Dereference operator.
Provides direct access to members of the property if it is of object type.
Definition at line 118 of file juce_CachedValue.h.
|
inline |
Returns the current property as a Value object.
Definition at line 232 of file juce_CachedValue.h.
References juce::ValueTree::getPropertyAsValue().
Referenced by juce::CachedValue< Type >::operator!=().
|
inline |
Returns the current fallback default value.
Definition at line 142 of file juce_CachedValue.h.
References juce::CachedValue< Type >::operator=(), juce::CachedValue< Type >::resetToDefault(), and juce::CachedValue< Type >::setValue().
|
inline |
Sets the property.
This will actually modify the property in the referenced ValueTree.
Definition at line 244 of file juce_CachedValue.h.
References juce::CachedValue< Type >::setValue().
Referenced by juce::CachedValue< Type >::getDefault().
|
inline |
Sets the property.
This will actually modify the property in the referenced ValueTree.
Definition at line 251 of file juce_CachedValue.h.
References juce::CachedValue< Type >::isUsingDefault(), and juce::ValueTree::setProperty().
Referenced by juce::CachedValue< Type >::getDefault(), and juce::CachedValue< Type >::operator=().
|
inline |
Resets the fallback default value.
Definition at line 162 of file juce_CachedValue.h.
References juce::CachedValue< Type >::forceUpdateOfCachedValue(), and juce::CachedValue< Type >::referTo().
|
inline |
Makes the CachedValue refer to the specified property inside the given ValueTree.
Definition at line 274 of file juce_CachedValue.h.
Referenced by juce::CachedValue< Type >::setDefault().
|
inline |
Force an update in case the referenced property has been changed from elsewhere.
Note: The CachedValue is a ValueTree::Listener and therefore will be informed of changes of the referenced property anyway (and update itself). But this may happen asynchronously. forceUpdateOfCachedValue() forces an update immediately.
Definition at line 286 of file juce_CachedValue.h.
References juce::ValueTree::addListener(), juce::ValueTree::getPropertyPointer(), and juce::ValueTree::removeListener().
Referenced by juce::CachedValue< Type >::resetToDefault(), and juce::CachedValue< Type >::setDefault().
|
inlinenoexcept |
Returns a reference to the ValueTree containing the referenced property.
Definition at line 183 of file juce_CachedValue.h.
|
inlinenoexcept |
Returns the property ID of the referenced property.
Definition at line 186 of file juce_CachedValue.h.
|
inlinenoexcept |
Returns the UndoManager that is being used.
Definition at line 189 of file juce_CachedValue.h.
References juce::CachedValue< Type >::CachedValue().