| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- Class List
- Class Index
- Class Hierarchy
- Class Members

Loading...
Searching...
No Matches
List of all members | Classes | Public Member Functions
AAX_CBinaryDisplayDelegate< T > Class Template Reference

`#include <AAX_CBinaryDisplayDelegate.h>`

Inheritance diagram for AAX_CBinaryDisplayDelegate< T >:
[legend]
Collaboration diagram for AAX_CBinaryDisplayDelegate< T >:
[legend]

## Description

template<typename T>
class AAX_CBinaryDisplayDelegate< T >

A binary display format conforming to AAX_IDisplayDelegate.

This display delegate converts a parameter value to one of two provided strings (e.g. "True" and "False".)

## Public Member Functions
| AAX_CBinaryDisplayDelegate (const char *falseString, const char *trueString)
| Constructor.
| AAX_CBinaryDisplayDelegate (const AAX_CBinaryDisplayDelegate &other)
AAX_IDisplayDelegate< T > * | Clone () const AAX_OVERRIDE
| Constructs and returns a copy of the display delegate.
bool | ValueToString (T value, AAX_CString *valueString) const AAX_OVERRIDE
| Converts a real parameter value to a string representation.
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.
bool | StringToValue (const AAX_CString &valueString, T *value) const AAX_OVERRIDE
| Converts a string to a real parameter value.
virtual void | AddShortenedStrings (const char *falseString, const char *trueString, int iStrLength)
virtual AAX_IDisplayDelegate * | Clone () const =0
| Constructs and returns a copy of the display delegate.
virtual bool | ValueToString (T value, AAX_CString *valueString) const =0
| Converts a real parameter value to a string representation.
virtual bool | ValueToString (T value, int32_t maxNumChars, AAX_CString *valueString) const =0
| Converts a real parameter value to a string representation using a size hint, useful for control surfaces and other character limited displays.
virtual bool | StringToValue (const AAX_CString &valueString, T *value) const =0
| Converts a string to a real parameter value.
Public Member Functions inherited from AAX_IDisplayDelegateBase
virtual | ~AAX_IDisplayDelegateBase ()
| Virtual destructor.

## Constructor & Destructor Documentation

## ◆ AAX_CBinaryDisplayDelegate() [1/2]

template<typename T >

AAX_CBinaryDisplayDelegate< T >::AAX_CBinaryDisplayDelegate | ( | const char * | falseString,
|  | const char * | trueString
| ) |  |

Constructor.

Parameters

  [in] | falseString | The string that will be associated with false parameter values
  [in] | trueString | The string that will be associated with true parameter values

References AAX_CString::Length().

Here is the call graph for this function:

## ◆ AAX_CBinaryDisplayDelegate() [2/2]

template<typename T >

AAX_CBinaryDisplayDelegate< T >::AAX_CBinaryDisplayDelegate | ( | const AAX_CBinaryDisplayDelegate< T > & | other | ) |

## Member Function Documentation

## ◆ Clone()

template<typename T >

AAX_IDisplayDelegate< T > * AAX_CBinaryDisplayDelegate< T >::Clone | ( |  | ) | const
| virtual

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]

template<typename T >

bool AAX_CBinaryDisplayDelegate< T >::ValueToString | ( | T | value,
|  | AAX_CString * | valueString
| ) |  | const
| virtual

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]

template<typename T >

bool AAX_CBinaryDisplayDelegate< T >::ValueToString | ( | T | value,
|  | int32_t | maxNumChars,
|  | AAX_CString * | valueString
| ) |  | const
| virtual

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()

template<typename T >

bool AAX_CBinaryDisplayDelegate< T >::StringToValue | ( | const AAX_CString & | valueString,
|  | T * | value
| ) |  | const
| virtual

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()

template<typename T >

void AAX_CBinaryDisplayDelegate< T >::AddShortenedStrings | ( | const char * | falseString,
|  | const char * | trueString,
|  | int | iStrLength
| ) |  |
| virtual

The documentation for this class was generated from the following file:

- AAX_CBinaryDisplayDelegate.h