Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: frmpage.h
Link against:

Class MPaginateObserver

MPaginateObserver

Support

Supported from 5.0

Description

An abstract class which specifies the protocol for a pagination observer. A pagination observer may be used when paginating a document in the background (using CTextPaginator::PaginateCompleteDocumentL()). It notifies the client on page completion, document completion, and on errors.

The observer is set up using the function CTextPaginator::SetObserver().

Defined in MPaginateObserver:
NotifyCompletion(), NotifyError(), NotifyPageCompletion()


NotifyCompletion()

virtual void NotifyCompletion()=0;

Description

Notifies the client on completion of document pagination.

[Top]


NotifyError()

virtual void NotifyError(TInt anErrorCode)=0;

Description

Notifies the client when a leave is trapped or when the pagination is cancelled. Implements error handling.

Parameters

TInt anErrorCode

Error code — indicates the type of error.

[Top]


NotifyPageCompletion()

virtual void NotifyPageCompletion(TInt aCurrentPageNum)=0;

Description

Called by the paginator when each page has been completed.

Parameters

TInt aCurrentPageNum

The number of the page.