Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: FRMPAGE.H

Class MPaginateObserver

class MPaginateObserver;

Description

An abstract class which must be mixed with application calling the active object. It 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().

Members

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


Member functions


NotifyCompletion()

virtual void NotifyCompletion()=0;

Description

Notifies the client on completion of document pagination.


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.


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.