| 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).
| Public Member Functions | |
|---|---|
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| void | InternalizeL(RReadStream &) |
| IMPORT_C void | RestoreL(const CStreamStore &, TStreamId) |
| IMPORT_C TStreamId | StoreL(CStreamStore &) |
| TUid | Type() |
| TInt | Value(TPtr &) |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const [virtual] |
| RWriteStream & aStream |
| void | InternalizeL | ( | RReadStream & | aStream | ) | [pure virtual] |
Internalises the field data. Called by RestoreL().
| RReadStream & aStream | Stream from which the field data should be internalised. |
| IMPORT_C void | RestoreL | ( | const CStreamStore & | aStore, |
| TStreamId | aId | |||
| ) | [virtual] | |||
| const CStreamStore & aStore | |
| TStreamId aId |
| IMPORT_C TStreamId | StoreL | ( | CStreamStore & | aStore | ) | const [virtual] |
| CStreamStore & aStore |
| 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.
| TPtr & aValueText | Descriptor which on return contains the field's updated value. |