Foxit PDF SDK
FoxitPDFSDKPython3.Progressive Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Progressive:
FoxitPDFSDKPython3.Base

Public Member Functions

def Progressive (other)
 Constructor, with another progressive object.
More...
 
def Continue ()
 Continue the progressive process.
More...
 
def GetRateOfProgress ()
 Get the rate of current progress.
More...
 

Static Public Attributes

 e_Finished = _fsdk.Progressive_e_Finished
 Progress state: progress is finished.

 
 e_ToBeContinued = _fsdk.Progressive_e_ToBeContinued
 Progress state: progress needs to be continued.

 

Detailed Description

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

Constructor & Destructor Documentation

◆ Progressive()

def FoxitPDFSDKPython3.Progressive.Progressive (   other)

Constructor, with another progressive object.

Parameters
[in]otherAnother progressive object.

Member Function Documentation

◆ Continue()

def FoxitPDFSDKPython3.Progressive.Continue ( )

Continue the progressive process.

Returns
FoxitPDFSDKPython3.Progressive.e_Finished means current process is finished successfully.
FoxitPDFSDKPython3.Progressive.e_ToBeContinued means current process is suspended, and this function needs to be called again to continue the process.
FoxitPDFSDKPython3.Progressive.e_Error means any error occurs.

◆ GetRateOfProgress()

def FoxitPDFSDKPython3.Progressive.GetRateOfProgress ( )

Get the rate of current progress.

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