#include <AAX_CStateDisplayDelegate.h>
template<typename T>
class AAX_CStateDisplayDelegate< T >
A generic display format conforming to AAX_IDisplayDelegate.
This display delegate is similar to AAX_CNumberDisplayDelegate, but does not include precision or spacing templatizations.
|
| AAX_CStateDisplayDelegate (const char *iStateStrings[], T iMinState=0) |
| Constructor taking a vector of C strings. More...
|
|
| AAX_CStateDisplayDelegate (int32_t inNumStates, const char *iStateStrings[], T iMinState=0) |
| Constructor taking a vector of C strings. More...
|
|
| AAX_CStateDisplayDelegate (const std::vector< AAX_IString * > &iStateStrings, T iMinState=0) |
| Constructor taking a vector of AAX_IString objects. More...
|
|
| AAX_CStateDisplayDelegate (const AAX_CStateDisplayDelegate &other) |
|
AAX_IDisplayDelegate< 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...
|
|
void | AddShortenedStrings (const char *iStateStrings[], int iLength) |
|
bool | Compare (const AAX_CString &valueString, const AAX_CString &stateString) const |
|
virtual | ~AAX_IDisplayDelegateBase () |
| Virtual destructor. More...
|
|
◆ AAX_CStateDisplayDelegate() [1/4]
Constructor taking a vector of C strings.
Each state name will be copied into the display delegate; the C strings may be disposed after construction.
- Note
iStateStrings
must be NULL-terminated
◆ AAX_CStateDisplayDelegate() [2/4]
Constructor taking a vector of C strings.
Each state name will be copied into the display delegate; the C strings may be disposed after construction.
State strings will be copied into the display delegate until either a NULL pointer is encountered or inNumStates
strings have been copied
◆ AAX_CStateDisplayDelegate() [3/4]
Constructor taking a vector of AAX_IString objects.
Each AAX_IString will be copied into the display delegate and may be disposed after construction. The AAX_IString will not be mutated.
◆ AAX_CStateDisplayDelegate() [4/4]
◆ Clone()
Constructs and returns a copy of the display delegate.
In general, this method's implementation can use a simple copy constructor:
template <typename T>
AAX_CSubclassDisplayDelegate<T>* AAX_CSubclassDisplayDelegate<T>::Clone() const
{
return new AAX_CSubclassDisplayDelegate(*this);
}
Implements AAX_IDisplayDelegate< T >.
◆ ValueToString() [1/2]
Converts a real parameter value to a string representation.
- Parameters
-
[in] | value | The real parameter value that will be converted |
[out] | valueString | A string corresponding to value |
- Return values
-
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
◆ ValueToString() [2/2]
Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.
- Parameters
-
[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 |
- Return values
-
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
◆ StringToValue()
Converts a string to a real parameter value.
- Parameters
-
[in] | valueString | The string that will be converted |
[out] | value | The real parameter value corresponding to valueString |
- Return values
-
true | The string conversion was successful |
false | The string conversion was unsuccessful |
Implements AAX_IDisplayDelegate< T >.
◆ AddShortenedStrings()
◆ Compare()
The documentation for this class was generated from the following file: