CEmsFormatIE Class Reference

class CEmsFormatIE : public CEmsInformationElement

CEmsFormatIE wraps the creation & modification of an EMS format information element into a single class. Format of Extended Object. ----------------------------

Position (Octet) Bit Description 1 Start Position 2 Text Formatting Length 3 Formatting mode 3 1..0 Alignment 1..0 0 0 Left 1..0 0 1 Center 1..0 1 0 Right 1..0 1 1 Lang depend (default)

3..2 FontSize 3..2 0 0 Normal 3..2 0 1 Large 3..2 1 0 Small 3..2 1 1 reserved

4 Style Bold (1=on) 5 Style Italic (1=on) 6 Style Underline (1=on) 7 Style Strikethrough (1=on)

4 3..0 Text Color (See header for values) 3gpp Vrs 5 7..4 Background Text Color (See header for values) 3gpp Vrs 5

3gpp Spec V5 section 9.2.3.24.10.1.1

Public Member Functions
IMPORT_C TAlignmentAlignment()
IMPORT_C TBoolBold()
IMPORT_C voidCopyL(const CEmsFormatIE &)
IMPORT_C CEmsInformationElement *DuplicateL()
IMPORT_C TFontSizeFontSize()
IMPORT_C TUintFormatLength()
IMPORT_C TBoolItalic()
IMPORT_C CEmsFormatIE *NewL()
IMPORT_C voidSetAlignment(TAlignment)
IMPORT_C voidSetBold(TBool)
IMPORT_C voidSetFontSize(TFontSize)
IMPORT_C voidSetFormatLength(TUint)
IMPORT_C voidSetItalic(TBool)
IMPORT_C voidSetStrikethrough(TBool)
IMPORT_C voidSetUnderline(TBool)
IMPORT_C TBoolStrikethrough()
IMPORT_C TBoolUnderline()
Private Member Functions
CEmsFormatIE()
voidDecodeBodyL(const TPtrC8, TBool)
voidEncodeBodyL(TPtr8, TBool)
TInt SerialisedBodyLength()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CEmsInformationElement::CEmsInformationElement(TSmsId,TBool)
CEmsInformationElement::CopyL(const CEmsInformationElement &)
CEmsInformationElement::DecodeInformationElementL(const CSmsInformationElement &)
CEmsInformationElement::EncodeInformationElementL()
CEmsInformationElement::ExternalizeL(RWriteStream &)const
CEmsInformationElement::InternalizeL(RReadStream &)
CEmsInformationElement::Length()const
CEmsInformationElement::SetStartPosition(TUint)
CEmsInformationElement::StartPosition()const
CSmsInformationElement::CSmsInformationElement(TSmsInformationElementIdentifier)
CSmsInformationElement::ConstructL(const TDesC8 &)
CSmsInformationElement::Data()
CSmsInformationElement::Data()const
CSmsInformationElement::DecodeL(TGsmuLex8 &)
CSmsInformationElement::EncodeL(TUint8 *)const
CSmsInformationElement::Identifier()const
CSmsInformationElement::NewDataL(TInt)
CSmsInformationElement::NewL(TSmsInformationElementIdentifier,const TDesC8 &)
CSmsInformationElement::~CSmsInformationElement()
Public Member Enumerations
enumTAlignment { ELeft = 0x00, ECenter = 0x01, ERight = 0x02, ELangDepend = 0x03 }
enumTColor {
EBlack = 0x00, EDarkGrey = 0x01, EDarkRed = 0x02, EDarkYellow = 0x03, EDarkGreen = 0x04, EDarkCyan = 0x05, EDarkBlue = 0x06, EDarkMagenta = 0x07, EGrey = 0x08, EWhite = 0x09, EBrightRed = 0x0A, EBrightYellow = 0x0B, EBrightGreen = 0x0C, EBrightCyan = 0x0D, EBrightBlue = 0x0E, EBrightMagenta = 0x0F
}
enumTEmsFormat {
EAlignmentMask = 0x03, EFontSizeMask = 0x0c, EBold = 0x10, EItalic = 0x20, EUnderline = 0x40, EStrikethrough = 0x80
}
enumTFontSize { ENormal = 0x00, ELarge = 0x01, ESmall = 0x02, EReserved = 0x03 }
Inherited Enumerations
CSmsInformationElement:TSmsInformationElementIdentifier
Private Attributes
TUint8 iFormat
TUint iFormatLength
Inherited Attributes
CEmsInformationElement::iEncodedBodyLength
CEmsInformationElement::iStartPosition
CSmsInformationElement::iData
CSmsInformationElement::iIdentifier

Constructor & Destructor Documentation

CEmsFormatIE()

CEmsFormatIE()[private]

Member Functions Documentation

Alignment()

IMPORT_C TAlignmentAlignment()const
capability
None

Bold()

IMPORT_C TBoolBold()const
capability
None

CopyL(const CEmsFormatIE &)

IMPORT_C voidCopyL(const CEmsFormatIE &aSrc)
capability
None

Parameters

const CEmsFormatIE & aSrc

DecodeBodyL(const TPtrC8, TBool)

voidDecodeBodyL(const TPtrC8aPtr,
TBoolaIsFromSerialisation
)[private, virtual]

Decodes the raw data out of an information element into this class.

leave
KErrargument If the size of the data does not match what is expected.

Parameters

const TPtrC8 aPtrThe raw predefined animation data
TBool aIsFromSerialisationboolean to indicate if it is from serialisation

DuplicateL()

IMPORT_C CEmsInformationElement *DuplicateL()const [virtual]

Creates an exact copy of the object.

capability
None

EncodeBodyL(TPtr8, TBool)

voidEncodeBodyL(TPtr8aPtr,
TBoolaIsForSerialisation
)const [private, virtual]

Encodes the format object into its raw format. (no IE id)

Parameters

TPtr8 aPtrthe buffer to be used which is to contain the data
TBool aIsForSerialisationboolean to indicate if it is for serialisation or encoding

FontSize()

IMPORT_C TFontSizeFontSize()const
capability
None

FormatLength()

IMPORT_C TUintFormatLength()const
capability
None

Italic()

IMPORT_C TBoolItalic()const
capability
None

NewL()

IMPORT_C CEmsFormatIE *NewL()[static]

Creates a default ems format object.

capability
None

SerialisedBodyLength()

TInt SerialisedBodyLength()const [private, virtual]

SetAlignment(TAlignment)

IMPORT_C voidSetAlignment(TAlignmentaAlignment)
capability
None

Parameters

TAlignment aAlignment

SetBold(TBool)

IMPORT_C voidSetBold(TBoolaBold)
capability
None

Parameters

TBool aBold

SetFontSize(TFontSize)

IMPORT_C voidSetFontSize(TFontSizeaSize)
capability
None

Parameters

TFontSize aSize

SetFormatLength(TUint)

IMPORT_C voidSetFormatLength(TUintaLength)
capability
None

Parameters

TUint aLength

SetItalic(TBool)

IMPORT_C voidSetItalic(TBoolaItalic)
capability
None

Parameters

TBool aItalic

SetStrikethrough(TBool)

IMPORT_C voidSetStrikethrough(TBoolaStrikethrough)
capability
None

Parameters

TBool aStrikethrough

SetUnderline(TBool)

IMPORT_C voidSetUnderline(TBoolaUnderline)
capability
None

Parameters

TBool aUnderline

Strikethrough()

IMPORT_C TBoolStrikethrough()const
capability
None

Underline()

IMPORT_C TBoolUnderline()const
capability
None

Member Enumerations Documentation

Enum TAlignment

Enumerators

ELeft = 0x00
ECenter = 0x01
ERight = 0x02
ELangDepend = 0x03

Enum TColor

Enumerators

EBlack = 0x00
EDarkGrey = 0x01
EDarkRed = 0x02
EDarkYellow = 0x03
EDarkGreen = 0x04
EDarkCyan = 0x05
EDarkBlue = 0x06
EDarkMagenta = 0x07
EGrey = 0x08
EWhite = 0x09
EBrightRed = 0x0A
EBrightYellow = 0x0B
EBrightGreen = 0x0C
EBrightCyan = 0x0D
EBrightBlue = 0x0E
EBrightMagenta = 0x0F

Enum TEmsFormat

Enumerators

EAlignmentMask = 0x03
EFontSizeMask = 0x0c
EBold = 0x10
EItalic = 0x20
EUnderline = 0x40
EStrikethrough = 0x80

Enum TFontSize

Enumerators

ENormal = 0x00
ELarge = 0x01
ESmall = 0x02
EReserved = 0x03

Member Data Documentation

TUint8 iFormat

TUint8 iFormat[private]

TUint iFormatLength

TUint iFormatLength[private]