![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CUnitPrefixDisplayDelegateDecorator.h>
A unit prefix decorator conforming to AAX_IDisplayDelegateDecorator.
This class is an AAX_IDisplayDelegateDecorator, meaning that it acts as a wrapper for other display delegates or concrete display types. For more information about display delegate decorators in AAX, see Display delegate decorators
The behavior of this class it to provide unit prefixes such as the k in kHz or the m in mm. It takes the value passed in and determines if the value is large or small enough to benefit from a unit modifier. If so, it adds that unit prefix character to the display string after scaling the number and calling deeper into the decorator pattern to get the concrete ValueToString() result.
The inverse is also supported, so if you type 1.5k in a text box and this decorator is in place, it should find the k and multiply the value by 1000 before converting it to a real value.
This decorator supports the following unit prefixes:
Public Member Functions | |
AAX_CUnitPrefixDisplayDelegateDecorator (const AAX_IDisplayDelegate< T > &displayDelegate) | |
AAX_CUnitPrefixDisplayDelegateDecorator< 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... | |
![]() | |
AAX_IDisplayDelegateDecorator (const AAX_IDisplayDelegate< T > &displayDelegate) | |
Constructor. More... | |
AAX_IDisplayDelegateDecorator (const AAX_IDisplayDelegateDecorator &other) | |
Copy constructor. More... | |
~AAX_IDisplayDelegateDecorator () AAX_OVERRIDE | |
Virtual destructor. More... | |
AAX_IDisplayDelegateDecorator< T > * | Clone () const AAX_OVERRIDE |
Constructs and returns a copy of the display delegate decorator. More... | |
bool | ValueToString (T value, AAX_CString *valueString) const AAX_OVERRIDE |
Converts a string to a real parameter value. More... | |
bool | ValueToString (T value, int32_t maxNumChars, AAX_CString *valueString) const AAX_OVERRIDE |
Converts a string to a real parameter value with a size constraint. 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... | |
AAX_CUnitPrefixDisplayDelegateDecorator< T >::AAX_CUnitPrefixDisplayDelegateDecorator | ( | const AAX_IDisplayDelegate< T > & | displayDelegate | ) |
|
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 >.
References AAX::fabsf(), and AAX_IDisplayDelegateDecorator< T >::ValueToString().
|
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 >.
References AAX::fabsf(), and AAX_IDisplayDelegateDecorator< T >::ValueToString().
|
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 >.
References AAX_CString::Erase(), AAX_CString::Length(), and AAX_IDisplayDelegateDecorator< T >::StringToValue().