Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: Gsmuelem.h
Link against: gsmu.lib

Class CSmsAlphabetConverter

class CSmsAlphabetConverter : public CBase;

Description

Utility to provide piecewise character set conversion to / from unpacked user data elements.

Derivation

Members

Defined in CSmsAlphabetConverter:
Alphabet(), ConvertFromNativeL(), ConvertToNativeL(), ESmsAlphabetWidthConversionFixed, ESmsAlphabetWidthConversionVariable, NewLC(), ResetUnconvertedNativeCharacters(), ResetUnconvertedUDElements(), TSmsAlphabetConversionProperties, TSmsAlphabetWidthConversion, UnconvertedNativeCharacters(), UnconvertedUDElements(), ~CSmsAlphabetConverter()

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


Construction and destruction


NewLC()

Capability: Illegal

static IMPORT_C CSmsAlphabetConverter *NewLC(CCnvCharacterSetConverter &aCharacterSetConverter, RFs &aFs, TSmsDataCodingScheme::TSmsAlphabet aSmsAlphabet, TBool aIsBinary);

Description

Allocates and creates a CSmsAlphabetConverter object, specifying an Alphabet Coding scheme and a Binary flag.

Parameters

CCnvCharacterSetConverter &aCharacterSetConverter

Pre-initialised character set converter

RFs &aFs

File system handle

TSmsDataCodingScheme::TSmsAlphabet aSmsAlphabet

Data coding scheme alphabet

TBool aIsBinary

Set to true for WAP or compressed data

Return value

CSmsAlphabetConverter *

New CSmsAlphabetConverter object


~CSmsAlphabetConverter()

Capability: Illegal

IMPORT_C ~CSmsAlphabetConverter();

Description

Destructor.

[Top]


Member functions


ConvertFromNativeL()

Capability: Illegal

IMPORT_C TPtrC8 ConvertFromNativeL(const TDesC &aNativeCharacters);

Description

Converts from the native character set to unpacked user data elements of the desired character set.

The function stores the converted data internally.

Parameters

const TDesC &aNativeCharacters

The native character set data (Unicode only)

Return value

TPtrC8

Converted characters


ConvertToNativeL()

Capability: Illegal

IMPORT_C TPtrC ConvertToNativeL(const TDesC8 &aUDElements);

Description

Converts the user data elements of the specified character set to the native character set.

Parameters

const TDesC8 &aUDElements

The converted character set data

Return value

TPtrC

Native character set data (Unicode only)


ResetUnconvertedNativeCharacters()

inline void ResetUnconvertedNativeCharacters();

Description

Resets the unconverted native character buffer.


ResetUnconvertedUDElements()

inline void ResetUnconvertedUDElements();

Description

Resets the unconverted user data elements buffer.


UnconvertedNativeCharacters()

inline TPtrC UnconvertedNativeCharacters();

Description

Gets the unconverted native characters.

Return value

TPtrC

Unconverted native characters


UnconvertedUDElements()

inline TPtrC8 UnconvertedUDElements();

Description

Gets the unconverted user data elements.

Return value

TPtrC8

Unconverted user data elements


Alphabet()

inline TSmsDataCodingScheme::TSmsAlphabet Alphabet() const;

Description

Gets the coding scheme alphabet.

Return value

TSmsDataCodingScheme::TSmsAlphabet

Coding scheme alphabet

[Top]


Member structures


Struct TSmsAlphabetConversionProperties

struct TSmsAlphabetConversionProperties;

Description

Holds the number of user data elements required for conversion from a single native character.

This value is applicable only if the iWidthConversion parameter is ESmsAlphabetWidthConversionFixed.

Members

Defined in CSmsAlphabetConverter::TSmsAlphabetConversionProperties:
iUDElementsPerNativeCharacter, iWidthConversion

Member data


iWidthConversion

TSmsAlphabetWidthConversion iWidthConversion;

Description

Alphabet width conversion.


iUDElementsPerNativeCharacter

TInt iUDElementsPerNativeCharacter;

Description

Number of user data elements required for conversion from a single native character

[Top]


Member enumerations


Enum TSmsAlphabetWidthConversion

TSmsAlphabetWidthConversion

Description

Indicates whether there is a fixed relationship between the number of characters and user data elements.

For example, Unicode characters always map to a single SMS UCS2 character, while a Unicode character might map to one, two or more SMS 7-bit User Data Elements (extended 7-bit characters).

ESmsAlphabetWidthConversionFixed

Fixed relationship.

ESmsAlphabetWidthConversionVariable

Variable relationship.