Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: concnf.h
Link against: conarc.lib

Class CCnaConverter

CCnaConverter

Support

Supported from 6.0

Description

Properties of a converter.

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

Derivation

CBaseBase class for all classes to be instantiated on the heap
CCnaConverterProperties of a converter

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

Inherited from CBase:
operator new()


Construction and destruction


NewL()

static CCnaConverter* NewL(TUid aUid);

Description

Allocates and constructs a CCnaConverter for a specified converter.

Parameters

TUid aUid

Converter UID

Return value

CCnaConverter*

New CCnaConverter


NewL()

static CCnaConverter* NewL(const CCnaConverter& aConverter);

Description

Allocates and copies a new CCnaConverter.

Parameters

const CCnaConverter& aConverter

Object to copy

Return value

CCnaConverter*

New CCnaConverter


NewLC()

static 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


NewLC()

static 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


~CCnaConverter()

~CCnaConverter();

Description

Destructor.

[Top]


Getters


CountFrom()

TInt CountFrom() const;

Description

Gets the number of source data types for the converter.

Return value

TInt

Number of source data types


CountTo()

TInt CountTo() const;

Description

Gets the number of target data types for the converter.

Return value

TInt

Number of target data types


MimeFrom()

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


MimeFrom()

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


MimeFromText()

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


MimeFromText()

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


MimeTo()

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


MimeTo()

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


MimeToText()

TTranslation MimeTo(const TDataType& aMimeType) const;

Description

Gets the localised name of the specified target target data type.

Parameters

const TDataType& aMimeType

Target data type

Return value

TTranslation

Localised name of the target data type


MimeToText()

TTranslation MimeToText(TInt aIndex) const;

Description

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

Parameters

TInt aIndex

Index of the target data type

Return value

TTranslation

Localised name of the target data type


Uid()

TUid Uid() const;

Description

Gets the converter UID.

Return value

TUid

Converter UID

[Top]


Setters


AddMimeFromL()

void AddMimeFromL(const CMimeInfo* aMimeInfo);

Description

Adds the specified source data type to the converter's properties.

Parameters

const CMimeInfo* aMimeInfo

Data type to add


AddMimeFromL()

void AddMimeFromL(const CMimeInfo* aMimeInfo);

Description

Adds the specified target data type to the converter's properties.

Parameters

const CMimeInfo* aMimeInfo

Data type to add


SetUid()

void SetUid(TUid aUid);

Description

Sets the converter UID.

Parameters

TUid aUid

Converter UID

[Top]


Persistence


ExternalizeL()

void ExternalizeL(RWriteStream& aStream) const;

Description

Externalises the object to the specified stream.

Parameters

RWriteStream& aStream

Stream to write to


InternalizeL()

void InternalizeL(RReadStream& aStream);

Description

Internalises the object from the specified stream.

Parameters

RReadStream& aStream

Stream to read from