CTextField Class Reference

class CTextField : public CBase

Abstract class: derive from this to instantiate a particular type of field (eg date etc) Abstract base class for all field types.

A field contains information which relates to a text object and can be automatically updated, e.g. page number or current date and time. Fields must implement the pure virtual functions defined in this class, including Value() which should calculate and return the field's new value, and Type() which returns the field's type UID. The type UID identifies the field type to the field factory (see class MTextFieldFactory).

Inherits from

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const [virtual]

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[pure virtual]

Internalises the field data. Called by RestoreL().

Parameters

RReadStream & aStreamStream from which the field data should be internalised.

RestoreL(const CStreamStore &, TStreamId)

IMPORT_C voidRestoreL(const CStreamStore &aStore,
TStreamIdaId
)[virtual]

Parameters

const CStreamStore & aStore
TStreamId aId

StoreL(CStreamStore &)

IMPORT_C TStreamIdStoreL(CStreamStore &aStore)const [virtual]

Parameters

CStreamStore & aStore

Type()

TUid Type()const [pure virtual]

Returns the field's type UID.

The field's type UID.

Value(TPtr &)

TInt Value(TPtr &aValueText)[pure virtual]

Sets aValueText to the current field value if the buffer is large enough. If not, aValueText is not changed, and the function returns the length which is required to hold the field's value.

Zero on success, otherwise, the length of the buffer which is required to hold the field's updated value.

Parameters

TPtr & aValueTextDescriptor which on return contains the field's updated value.