Class CNumPagesField

class CNumPagesField : public CPageFieldBase;

Description

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

• CPageFieldBase - Stores a style for displaying the value of numeric fields

• CNumPagesField - A field which evaluates to the number of pages in the document

Members

Defined in CNumPagesField:
SetNumPagesInfo(), Type(), Value(), iNumPagesInfo

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CPageFieldBase:
EAlphabeticLower, EAlphabeticUpper, EArabic, ERomanLower, ERomanUpper, ExternalizeL(), InternalizeL(), NumberStyle(), SetNumberStyle(), TNumberStyle, iStyle

Inherited from CTextField:
RestoreL(), StoreL()

inline void SetNumPagesInfo(MFieldNumPagesInfo *aInfo);

Description

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().

virtual IMPORT_C TInt Value(TPtr &aValueText);

Description

Gets the total number of pages in the document, by calling UpdateFieldNumPages() (implemented by the object passed to the field using SetNumPagesInfo()).

Notes

SetNumPagesInfo() must have been called beforehand, or a panic occurs.

The text object should support pagination and pagination should have occurred before evaluating the field.

Parameters

TPtr &aValueText Descriptor which on return contains the number of pages in the document, converted into the appropriate style, as set by CPageFieldBase::SetNumberStyle().

Return value

TInt Zero if aValueText is long enough to hold the string. Otherwise, the length of the buffer which is required to hold the string.

virtual IMPORT_C TUid Type() const;

Description

Gets the field's type UID.

Return value

TUid KNumPagesFieldUid.

protected: MFieldNumPagesInfo * iNumPagesInfo;

Description