![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CStringDisplayDelegate.h>
A string, or list, display format conforming to AAX_IDisplayDelegate.
This display delegate uses a string map to associate parameter values with specific strings. This kind of display delegate is most often used for control string or list parameters, which would internally use an integer parameter type. The int value would then be used as a lookup into this delegate, which would return a string for each valid int value.
Public Member Functions | |
AAX_CStringDisplayDelegate (const std::map< T, AAX_CString > &stringMap) | |
Constructor. More... | |
AAX_CStringDisplayDelegate< T > * | Clone () const AAX_OVERRIDE |
Constructs and returns a copy of the display delegate. More... | |
bool | ValueToString (T value, AAX_CString *valueString) const AAX_OVERRIDE |
Converts a real parameter value to a string representation. More... | |
bool | ValueToString (T value, int32_t maxNumChars, AAX_CString *valueString) const AAX_OVERRIDE |
Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays. More... | |
bool | StringToValue (const AAX_CString &valueString, T *value) const AAX_OVERRIDE |
Converts a string to a real parameter value. More... | |
![]() | |
virtual | ~AAX_IDisplayDelegateBase () |
Virtual destructor. More... | |
Protected Attributes | |
std::map< T, AAX_CString > | mStringMap |
std::map< AAX_CString, T > | mInverseStringMap |
AAX_CStringDisplayDelegate< T >::AAX_CStringDisplayDelegate | ( | const std::map< T, AAX_CString > & | stringMap | ) |
Constructor.
Constructs a String Display Delegate with a provided string map.
[in] | stringMap | A populated map of value-string pairs |
References AAX_CStringDisplayDelegate< T >::mInverseStringMap, and AAX_CStringDisplayDelegate< T >::mStringMap.
|
virtual |
Constructs and returns a copy of the display delegate.
In general, this method's implementation can use a simple copy constructor:
Implements AAX_IDisplayDelegate< T >.
|
virtual |
Converts a real parameter value to a string representation.
[in] | value | The real parameter value that will be converted |
[out] | valueString | A string corresponding to value |
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
|
virtual |
Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.
[in] | value | The real parameter value that will be converted |
[in] | maxNumChars | Size hint for the desired maximum number of characters in the string (not including null termination) |
[out] | valueString | A string corresponding to value |
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
|
virtual |
Converts a string to a real parameter value.
[in] | valueString | The string that will be converted |
[out] | value | The real parameter value corresponding to valueString |
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
|
protected |
|
protected |