CPageNumField Class Reference
|
class CPageNumField : public CPageFieldBase
|
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.
Member Functions Documentation
SetPageNumInfo(MFieldPageNumInfo *)
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
|
MFieldPageNumInfo
* aInfo
|
Pointer to an object which implements UpdateFieldPageNum().
|
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
MFieldPageNumInfo * iPageNumInfo
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.