Foxit PDF SDK  9.1
FSProgressive Class Reference
Inheritance diagram for FSProgressive:
FSBase

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(int) - getRateOfProgress
 Get the rate of current progress.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithOther:
 Constructor, with another progressive object.
More...
 
(id) - NS_UNAVAILABLE
 
(FSProgressiveState- resume
 Continue the progressive process.
More...
 

Additional Inherited Members

- Protected Attributes inherited from FSBase
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

This class represents a progressive object, which is used for progressive process such as loading document, parsing page and so on.

Method Documentation

◆ dealloc

- (void) dealloc

Reimplemented from FSBase.

◆ getCptr

- (void*) getCptr

Reimplemented from FSBase.

◆ getRateOfProgress

- (int) getRateOfProgress

Get the rate of current progress.

Returns
An integer between 0 and 100 (inclusive), indicating the rate of current progress. -1 means error.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSBase.

◆ initWithOther:

- (id) initWithOther: (FSProgressive*)  other

Constructor, with another progressive object.

Parameters
[in]otherAnother progressive object.

◆ NS_UNAVAILABLE

- (id) NS_UNAVAILABLE

◆ resume

- (FSProgressiveState) resume

Continue the progressive process.

Returns
FSProgressiveFinished means current process is finished successfully.
FSProgressiveToBeContinued means current process is suspended, and this function needs to be called again to continue the process.
FSProgressiveError means any error occurs.