Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::pdf::AnnotationSummary类 参考
类 foxit::pdf::AnnotationSummary 继承关系图:

## Public 成员函数
| AnnotationSummary (const pdf::PDFDoc &document)
| 构造函数。 更多...
| AnnotationSummary (const AnnotationSummary &other)
| 构造函数，使用另一个注释摘要对象。 更多...
| ~AnnotationSummary ()
| 析构函数。
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const AnnotationSummary &other) const
| 不等运算符。 更多...
AnnotationSummary & | operator= (const AnnotationSummary &other)
| 赋值运算符。 更多...
bool | operator== (const AnnotationSummary &other) const
| 相等运算符。 更多...
void | SetCallback (AnnotationSummaryCallback *callback)
| 为注释摘要设置回调对象。 更多...
common::Progressive | StartSummarize (const char *dest_file_path, const AnnotationSummarySettings &settings, common::PauseCallback *pause=0)
| 开始摘要注释。 更多...
common::Progressive | StartSummarize (const wchar_t *dest_file_path, const AnnotationSummarySettings &settings, common::PauseCallback *pause=0)
| 开始摘要注释。 更多...
common::Progressive | StartSummarize (foxit::common::file::WriterCallback *dest_file, const AnnotationSummarySettings &settings, foxit::common::PauseCallback *pause=0)
| 开始摘要注释。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类可用于摘要注释并生成 PDF 文件作为结果文档。

## 构造及析构函数说明

## ◆ AnnotationSummary() [1/2]

foxit::pdf::AnnotationSummary::AnnotationSummary | ( | const pdf::PDFDoc & | document | ) |

构造函数。

参数

  [in] | document | 有效的 PDF 文档。它应该已成功加载。

## ◆ AnnotationSummary() [2/2]

foxit::pdf::AnnotationSummary::AnnotationSummary | ( | const AnnotationSummary & | other | ) |

构造函数，使用另一个注释摘要对象。

参数

  [in] | other | 另一个注释摘要对象。

## 成员函数说明

## ◆ IsEmpty()

bool foxit::pdf::AnnotationSummary::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不为空。

## ◆ operator!=()

bool foxit::pdf::AnnotationSummary::operator!= | ( | const AnnotationSummary & | other | ) | const

不等运算符。

参数

  [in] | other | 另一个注释摘要对象。此函数将检查当前对象是否与此对象不相等。

返回
  true 表示不相等，而 false 表示相等。

## ◆ operator=()

AnnotationSummary& foxit::pdf::AnnotationSummary::operator= | ( | const AnnotationSummary & | other | ) |

赋值运算符。

参数

  [in] | other | 另一个注释摘要对象，其值将被赋给当前对象。

返回
  对当前对象本身的引用。

## ◆ operator==()

bool foxit::pdf::AnnotationSummary::operator== | ( | const AnnotationSummary & | other | ) | const

相等运算符。

参数

  [in] | other | 另一个注释摘要对象。此函数将检查当前对象是否与此对象相等。

返回
  true 表示相等，而 false 表示不相等。

## ◆ SetCallback()

void foxit::pdf::AnnotationSummary::SetCallback | ( | AnnotationSummaryCallback * | callback | ) |

为注释摘要设置回调对象。

如果不调用此函数，表示不使用回调。

参数

  [in] | callback | 用户实现的 AnnotationSummaryCallback 对象。 用户可以通过此回调在摘要注释期间更改某些信息/数据。 请确保回调对象在当前 AnnotationSummary 对象的生命周期结束前保持有效。 如果这是 NULL，表示使用默认信息/数据。

返回
  无。

## ◆ StartSummarize() [1/3]

common::Progressive foxit::pdf::AnnotationSummary::StartSummarize | ( | const char * | dest_file_path,
|  | const AnnotationSummarySettings & | settings,
|  | common::PauseCallback * | pause = `0`
| ) |  |

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。 如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 AnnotationSummarySettings::SetAnnotType 的注释）， 或相关源 PDF 文档没有任何注释， 此函数将抛出异常 foxit::e_ErrUnknown。

参数

  [in] | dest_file_path | 保存注释摘要结果 PDF 文件的完整路径。这不应该是空字符串。
  [in] | settings | 用于摘要注释的设置数据。
  [in] | pause | 决定是否需要暂停摘要过程的暂停对象。 这可以是 NULL，表示在解析过程中不暂停。 如果这不是 NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。

返回
  渐进对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是 100，调用函数 common::Progressive::Continue 继续进度，直到进度完成。

## ◆ StartSummarize() [2/3]

common::Progressive foxit::pdf::AnnotationSummary::StartSummarize | ( | const wchar_t * | dest_file_path,
|  | const AnnotationSummarySettings & | settings,
|  | common::PauseCallback * | pause = `0`
| ) |  |

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。 如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 AnnotationSummarySettings::SetAnnotType 的注释）， 或相关源 PDF 文档没有任何注释， 此函数将抛出异常 foxit::e_ErrUnknown。

参数

  [in] | dest_file_path | 保存注释摘要结果 PDF 文件的完整路径。这不应该是空字符串。
  [in] | settings | 用于摘要注释的设置数据。
  [in] | pause | 决定是否需要暂停摘要过程的暂停对象。 这可以是 NULL，表示在解析过程中不暂停。 如果这不是 NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。

返回
  渐进对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是 100，调用函数 common::Progressive::Continue 继续进度，直到进度完成。

## ◆ StartSummarize() [3/3]

common::Progressive foxit::pdf::AnnotationSummary::StartSummarize | ( | foxit::common::file::WriterCallback * | dest_file,
|  | const AnnotationSummarySettings & | settings,
|  | foxit::common::PauseCallback * | pause = `0`
| ) |  |

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。 如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 AnnotationSummarySettings::SetAnnotType 的注释）， 或相关源 PDF 文档没有任何注释， 此函数将抛出异常 foxit::e_ErrUnknown。

参数

  [in] | dest_file | 用户实现的 common::file::WriterCallback 对象， 用于以自定义方法将注释摘要数据存储到 PDF 文件作为结果。
  [in] | settings | 用于摘要注释的设置数据。
  [in] | pause | 决定是否需要暂停摘要过程的暂停对象。 这可以是 NULL，表示在解析过程中不暂停。 如果这不是 NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。

返回
  渐进对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。如果比率还不是 100，调用函数 common::Progressive::Continue 继续进度，直到进度完成。