Class CCnaConverter

class CCnaConverter : public CBase;

Description

Holds the inherent properties of a converter.

These are its UID and the data types it supports.

Note that the setter functions affect only the current object, not the stored information for the converter.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CCnaConverter - Holds the inherent properties of a converter

Members

Defined in CCnaConverter:
CountFrom(), CountTo(), MimeFrom(), MimeFrom(), MimeFromText(), MimeFromText(), MimeTo(), MimeTo(), MimeToText(), MimeToText(), NewL(), NewL(), NewLC(), NewLC(), SetUid(), Uid(), ~CCnaConverter()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CCnaConverter *NewL(TUid aUid);

Description

Allocates and constructs a CCnaConverter for a specified converter.

Parameters

TUid aUid Converter UID

Return value

CCnaConverter * New CCnaConverter

static IMPORT_C CCnaConverter *NewLC(TUid aUid);

Description

Allocates and constructs a CCnaConverter for a specified converter, leaving the object on the cleanup stack.

Parameters

TUid aUid Converter UID

Return value

CCnaConverter * New CCnaConverter

static IMPORT_C CCnaConverter *NewL(const CCnaConverter &aConverter);

Description

Allocates and copies a new CCnaConverter.

Parameters

const CCnaConverter &aConverter Object to copy

Return value

CCnaConverter * New CCnaConverter

static IMPORT_C CCnaConverter *NewLC(const CCnaConverter &aConverter);

Description

Allocates and copies a new CCnaConverter, leaving the object on the cleanup stack.

Parameters

const CCnaConverter &aConverter Object to copy

Return value

CCnaConverter * New CCnaConverter

IMPORT_C ~CCnaConverter();

Description

Destructor.

IMPORT_C void SetUid(TUid aUid);

Description

Sets the converter UID.

Parameters

TUid aUid Converter UID

IMPORT_C TBool MimeFrom(const TDataType &aMimeType) const;

Description

Tests if the specified source data type is available.

Parameters

const TDataType &aMimeType Source data type

Return value

TBool True if the converter supports the source data type, else false

IMPORT_C TBool MimeTo(const TDataType &aMimeType) const;

Description

Tests if the specified target data type is available.

Parameters

const TDataType &aMimeType Target data type

Return value

TBool True if the converter supports the target data type, else false

IMPORT_C TTranslation MimeFromText(const TDataType &aMimeType) const;

Description

Gets the localised name of the specified source data type.

Parameters

const TDataType &aMimeType Source data type

Return value

TTranslation Localised name of the source data type

IMPORT_C TTranslation MimeToText(const TDataType &aMimeType) const;

Description

Gets the localised name of the specified target data type.

Parameters

const TDataType &aMimeType Target data type

Return value

TTranslation Localised name of the target data type

IMPORT_C TInt CountFrom() const;

Description

Gets the number of source data types for the converter.

Return value

TInt Number of source data types

IMPORT_C TInt CountTo() const;

Description

Gets the number of target data types for the converter.

Return value

TInt Number of target data types

IMPORT_C TDataType MimeFrom(TInt aIndex) const;

Description

Gets the n'th source data type of the converter.

Parameters

TInt aIndex Index of the source data type to get

Return value

TDataType Source data type

IMPORT_C TDataType MimeTo(TInt aIndex) const;

Description

Gets the n'th target data type of the converter.

Parameters

TInt aIndex Index of the target data type to get

Return value

TDataType Target data type

IMPORT_C TTranslation MimeFromText(TInt aIndex) const;

Description

Gets the localised name of the n'th source data type.

Parameters

TInt aIndex Index of the source data type

Return value

TTranslation Localised name of the source data type

IMPORT_C TTranslation MimeToText(TInt aIndex) const;

Description

Gets the localised name of the n'th target data type.

Parameters

TInt aIndex Index of the target data type

Return value

TTranslation Localised name of the target data type

inline TUid Uid() const;

Description

Gets the converter UID.

Return value

TUid Converter UID