Class CCnvCharacterSetNames

class CCnvCharacterSetNames : public CBase, public MDesC16Array;

Description

A localised list of the names of non-Unicode character set encodings supported on the phone.

For each character conversion plug-in DLL, there are one or more resource files which contain the name of the encoding translated into a different language.

This class populates a list of the names of all encodings supported on the phone by reading the appropriate resource file for each one. The list is sorted according to the collation rules for the device's current locale.

The virtual functions MdcaCount() (returns the number of items in the list) and MdcaPoint() (returns a TPtrC for the item at the given index) are implemented privately in this class. Users of this class can call them through the MDesCArray interface.

Derivation

• MDesC16Array - Interface class for 16 bit descriptor arrays
• CBase - Base class for all classes to be instantiated on the heap

• CCnvCharacterSetNames - A localised list of the names of non-Unicode character set encodings supported on the phone

Members

Defined in CCnvCharacterSetNames:
IdentifierAtIndex(), IndexOfIdentifier(), MdcaCount(), MdcaPoint(), NewL(), NewLC(), ~CCnvCharacterSetNames()

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

static IMPORT_C CCnvCharacterSetNames *NewL(RFs &aFileServerSession, const TArray< CCnvCharacterSetConverter::SCharacterSet > &aArrayOfCharacterSetsAvailable);

Description

Allocates and constructs a localised list of character set encoding names.

Parameters

RFs &aFileServerSession A connected session with the file server. const TArray< CCnvCharacterSetConverter::SCharacterSet > &aArrayOfCharacterSetsAvailable The array of character sets available on the phone. This can be created using CCnvCharacterSetConverter::CreateArrayOfCharacterSetsAvailableL() or CreateArrayOfCharacterSetsAvailableLC().

Return value

CCnvCharacterSetNames * Pointer to the newly created object.

static IMPORT_C CCnvCharacterSetNames *NewLC(RFs &aFileServerSession, const TArray< CCnvCharacterSetConverter::SCharacterSet > &aArrayOfCharacterSetsAvailable);

Description

Allocates and constructs a localised list of character set encoding names. Puts a pointer to the object on the cleanup stack.

Parameters

RFs &aFileServerSession A connected session with the file server. const TArray< CCnvCharacterSetConverter::SCharacterSet > &aArrayOfCharacterSetsAvailable The array of character sets available on the phone. This can be created using CCnvCharacterSetConverter::CreateArrayOfCharacterSetsAvailableL() or CreateArrayOfCharacterSetsAvailableLC().

Return value

CCnvCharacterSetNames * Pointer to the newly created object.

virtual IMPORT_C ~CCnvCharacterSetNames();

Description

Deletes the array of named plug-ins owned by the object prior to its destruction.

IMPORT_C TInt IndexOfIdentifier(TUint aIdentifier) const;

Description

Gets the index into the sorted list of the character set identifier specified.

Parameters

TUint aIdentifier The character set identifier. This must not be zero, or a panic occurs.

Return value

TInt The index into the list of the character set identifier, or KErrNotFound if the identifier does not exist in the list.

IMPORT_C TUint IdentifierAtIndex(TInt aIndex) const;

Description

Gets the character set identifier at the specified index into the list.

Parameters

TInt aIndex The index into the list. Must be within the bounds of the array, or a panic occurs.

Return value

TUint The character set identifier at the specified index.

private: virtual TInt MdcaCount() const;

Description

Requirements

Returns the number of descriptor elements in a descriptor array.

Return value

TInt The number of descriptor elements in a descriptor array.

private: virtual TPtrC MdcaPoint(TInt aIndex) const;

Description

Requirements

Indexes into a descriptor array.

Parameters

TInt aIndex The position of the descriptor element within a descriptor array. The position is relative to zero; i.e. zero implies the first descriptor element in a descriptor array.

Return value

TPtrC A 16 bit non-modifiable pointer descriptor representing the descriptor element located at position aIndex within a descriptor array.