Foxit PDF SDK
foxit::common::Progressive类 参考
类 foxit::common::Progressive 继承关系图:
foxit::Base

Public 类型

enum  State { e_Error = 0, e_ToBeContinued = 1, e_Finished = 2 }
 进度状态的枚举。 更多...
 

Public 成员函数

 Progressive (const Progressive &other)
 使用另一个progressive对象的构造函数。 更多...
 
 ~Progressive ()
 析构函数。
 
State Continue ()
 继续渐进式处理过程。 更多...
 
int GetRateOfProgress ()
 获取当前进度的比率。 更多...
 
Progressiveoperator= (const Progressive &other)
 赋值操作符。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类表示一个渐进式对象,用于渐进式处理,如加载文档、 解析页面等。

成员枚举类型说明

◆ State

进度状态的枚举。

此枚举的值应单独使用。

枚举值
e_Error 

进度状态:发生任何错误。

e_ToBeContinued 

进度状态:进度需要继续。

e_Finished 

进度状态:进度已完成。

构造及析构函数说明

◆ Progressive()

foxit::common::Progressive::Progressive ( const Progressive other)

使用另一个progressive对象的构造函数。

参数
[in]other另一个progressive对象。

成员函数说明

◆ Continue()

State foxit::common::Progressive::Continue ( )

继续渐进式处理过程。

返回
Progressive::e_Finished 意味着当前处理已成功完成。
Progressive::e_ToBeContinued 意味着当前处理已暂停, 需要再次调用此函数以继续处理。
Progressive::e_Error 意味着发生了错误。

◆ GetRateOfProgress()

int foxit::common::Progressive::GetRateOfProgress ( )

获取当前进度的比率。

返回
0到100之间的整数(包含边界值),表示当前进度的比率。 -1表示错误。

◆ operator=()

Progressive& foxit::common::Progressive::operator= ( const Progressive other)

赋值操作符。

参数
[in]other另一个progressive对象,其值将赋给当前对象。
返回
当前对象本身的引用。