CPageFieldBase Class Reference

#include <fldbltin.h>

Link against: field.lib

class CPageFieldBase : public CTextField, public CTextField

Inherits from

CPageFieldBase
- CTextField
  - CBase
  - CBase
- CTextField
  - CBase
  - CBase

Protected Attributes
TNumberStyle	iStyle

Public Member Enumerations
enum	TNumberStyle { EArabic, ERomanUpper, ERomanLower, EAlphabeticUpper, EAlphabeticLower }

Public Member Functions
virtual IMPORT_C void	ExternalizeL(RWriteStream &)
virtual IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TNumberStyle	NumberStyle()
void	SetNumberStyle(TNumberStyle)

Protected Member Functions
TInt	InsertValue(TPtr &, TInt)

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()
	CTextField::RestoreL(const CStreamStore &,TStreamId)
	CTextField::StoreL(CStreamStore &)const
	CTextField::Type()const
	CTextField::Value(TPtr &)

Detailed 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.

Member Attribute Documentation

iStyle

TNumberStyle

iStyle

[protected]

Member Enumeration Documentation

Enum TNumberStyle

Numeric style

Enumerator	Value	Description
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.

Member Function Documentation

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Reimplemented from CTextField::ExternalizeL(RWriteStream &)const

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
aStream	Stream to which the numeric style should be externalised.

InsertValue ( TPtr &, TInt )

TInt	InsertValue	(	TPtr &	aValueText,
			TInt	aValue
		)	[protected]

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Reimplemented from CTextField::InternalizeL(RReadStream &)

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
aStream	Stream from which the numeric style should be internalised.

NumberStyle ( )

IMPORT_C TNumberStyle

NumberStyle

(

)

const

Gets the numeric style.

Return Value: The numeric style.

SetNumberStyle ( TNumberStyle )

void

SetNumberStyle

(

TNumberStyle

aStyle

)

[inline]

Sets the numeric style.

Parameters
aStyle	The numeric style.