CNumPagesField Class Reference

class CNumPagesField : public CPageFieldBase

A field which evaluates to the number of pages in the document.

Before the number of pages field can be evaluated, it must be passed a pointer to an object which implements the UpdateFieldNumPages() function.

Inherits from

Member Functions Documentation

SetNumPagesInfo(MFieldNumPagesInfo *)

void SetNumPagesInfo ( MFieldNumPagesInfo * aInfo ) [inline]

Sets the object which implements UpdateFieldNumPages(), to get the number of pages in the document. SetNumPagesInfo() must be called before the number of pages field can be evaluated.

Parameters

MFieldNumPagesInfo * aInfo Pointer to an object which implements UpdateFieldNumPages().

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

MFieldNumPagesInfo * iNumPagesInfo

MFieldNumPagesInfo * iNumPagesInfo [protected]