CFileNameField Class Reference
| class CFileNameField : public CTextField |
A filename field.
This is a field which evaluates to the filename of the current document. Before the filename field can be evaluated, it must be passed a pointer to an object which implements the UpdateFieldFileName() function.
Member Functions Documentation
InternalizeL(RReadStream &)
Overrides the base class method to do nothing, because this class has no persistent data.
RestoreL(const CStreamStore &, TStreamId)
Restores the field data from a stream store. Concrete field types with no persistent data should override this function to do nothing.
Parameters
| const CStreamStore & aStore | Stream store containing the field data to restore. |
| TStreamId aId | The ID of the stream store in which the field data was previously stored. |
SetFileNameInfo(MFieldFileNameInfo *)
Sets the object which implements the UpdateFieldFileName() function, to get the current document's filename. SetFileNameInfo() must be called before the filename field can be evaluated.
Parameters
| MFieldFileNameInfo * aInfo | Pointer to an object which implements the UpdateFieldFileName() function. |
StoreL(CStreamStore &)
Stores the field data to a stream store. Concrete field types with no persistent data should override this function to return KNullStreamId.
Parameters
| CStreamStore & aStore | Stream store to which the field data is written. |
Type()
| IMPORT_C TUid | Type | ( | ) | const [virtual] |
Returns the field's type UID.
Value(TPtr &)
| IMPORT_C TInt | Value | ( | TPtr & | aValueText | ) | [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.
Parameters
| TPtr & aValueText | Descriptor which on return contains the field's updated value. |
Member Data Documentation
MFieldFileNameInfo * iFileNameInfo
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.