Collapse all Symbian^3 Application Developer Library

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.

Inherits from

CFileNameField
- CTextField
  - CBase

Public Member Functions
void	InternalizeL ( RReadStream &)
IMPORT_C void	RestoreL (const CStreamStore &, TStreamId )
void	SetFileNameInfo ( MFieldFileNameInfo *)
IMPORT_C TStreamId	StoreL ( CStreamStore &)
IMPORT_C TUid	Type ()
IMPORT_C TInt	Value ( TPtr &)

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::ExternalizeL(RWriteStream &)const

Protected Attributes
MFieldFileNameInfo *	iFileNameInfo

Member Functions Documentation

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

)

[inline, virtual]

Overrides the base class method to do nothing, because this class has no persistent data.

Parameters

RReadStream &

RestoreL(const CStreamStore &, TStreamId)

IMPORT_C void	RestoreL	(	const CStreamStore &	aStore,
			TStreamId	aId
		)	[virtual]

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 *)

void

SetFileNameInfo

(

MFieldFileNameInfo *

aInfo

)

[inline]

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 &)

IMPORT_C TStreamId

StoreL

(

CStreamStore &

aStore

)

const [virtual]

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

MFieldFileNameInfo *

iFileNameInfo

[protected]