#include <fldbltin.h>
Link against: field.lib
| class CPageNumField : public CPageFieldBase, public CPageFieldBase |
| Protected Attributes | |
|---|---|
| MFieldPageNumInfo * | iPageNumInfo |
| Public Member Functions | |
|---|---|
| void | SetPageNumInfo(MFieldPageNumInfo *) |
| virtual IMPORT_C TUid | Type() |
| virtual IMPORT_C TInt | Value(TPtr &) |
| Inherited Attributes | |
|---|---|
| CPageFieldBase::iStyle | |
| Inherited Enumerations | |
|---|---|
| CPageFieldBase:TNumberStyle | |
A field which evaluates to the current page number in the document.
Before the page number field can be evaluated, it must be passed a pointer to an object which implements the UpdateFieldPageNum() function.
| MFieldPageNumInfo * | iPageNumInfo | [protected] |
| void | SetPageNumInfo | ( | MFieldPageNumInfo * | aInfo | ) | [inline] |
Sets the object which implements UpdateFieldPageNum(), to get the current page number. SetPageNumInfo() must be called before the page number field can be evaluated.
| Parameters | |
|---|---|
| aInfo | Pointer to an object which implements UpdateFieldPageNum(). |
| IMPORT_C TUid | Type | ( | ) | const [virtual] |
Reimplemented from CTextField::Type()const
Gets the field's type UID.
Reimplemented from CTextField::Value(TPtr &)
Gets the current page number, by calling UpdateFieldPageNum() (implemented by the object passed to the field using SetPageNumInfo()).
Notes
SetPageNumInfo() 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 | |
|---|---|
| aValueText | Descriptor which on return contains the current page number, converted into the appropriate style, as set by CPageFieldBase::SetNumberStyle(). |