Class CPageFieldBase

CPageFieldBase

Support

Supported from 5.0

Description

Stores a style for displaying the value of numeric fields. This style is used when converting the integer value of numeric fields into a descriptor for display in another format, e.g. Arabic, Roman, alphabetic. This is the base class for the numeric fields, CPageNumField and CNumPagesField.

Derivation

CBase Base class for all classes to be instantiated on the heap CPageFieldBase Stores a style for displaying the value of numeric fields CTextField The abstract base class for all fields

Defined in CPageFieldBase:
EAlphabeticLower, EAlphabeticUpper, EArabic, ERomanLower, ERomanUpper, ExternalizeL(), InternalizeL(), NumberStyle(), SetNumberStyle(), TNumberStyle

Inherited from CBase:
operator new()

Inherited from CTextField:
RestoreL(), StoreL(), Type(), Value()

void ExternalizeL(RWriteStream& aStream)const;

Description

Externalises the numeric style value to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RWriteStream& aStream Stream to which the numeric style should be externalised.

void InternalizeL(RReadStream& aStream);

Description

Internalises the numeric style value from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters

RReadStream& aStream Stream from which the numeric style should be internalised.

TNumberStyle NumberStyle()const;

Description

Gets the numeric style.

Return value

TNumberStyle The numeric style.

void SetNumberStyle(TNumberStyle aStyle);

Description

Sets the numeric style.

Parameters

TNumberStyle aStyle The numeric style.

TNumberStyle

Description

Numeric style

EArabic Arabic numeral, e.g. 1, 2, 3. ERomanUpper Upper case Roman numeral, e.g. I, II, III. ERomanLower Lower case Roman numeral, e.g. i, ii, iii. EAlphabeticUpper Upper case alphabetic. EAlphabeticLower Lower case alphabetic.