Foxit PDF SDK

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

## Public 成员函数
| LRContext (const LRContext &other)
| 构造函数，使用另一个上下文对象。 更多...
| LRContext (const pdf::PDFPage &page)
| 构造函数，基于PDF页面对象。 更多...
| ~LRContext ()
| 析构函数。
LRStructureElement | GetRootElement ()
| 获取结构树的根元素。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const LRContext &other) const
| 不等于运算符。 更多...
LRContext & | operator= (const LRContext &other)
| 赋值运算符。 更多...
bool | operator== (const LRContext &other) const
| 等于运算符。 更多...
common::Progressive | StartParse (common::PauseCallback *pause=0)
| 开始解析相关PDF页面的布局识别。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类可用于解析布局识别以获取根元素。

## 构造及析构函数说明

## ◆ LRContext() [1/2]

foxit::addon::layoutrecognition::LRContext::LRContext | ( | const pdf::PDFPage & | page | ) |

构造函数，基于PDF页面对象。

参数

  [in] | page | 有效的PDF页面对象。

注解
  如果在函数common::Library::Initialize中使用的许可证信息中未定义模块"LayoutRecognition"， 这意味着用户无权使用布局识别相关函数，此构造函数将抛出异常foxit::e_ErrNoLayoutRecognitionModuleRight。

## ◆ LRContext() [2/2]

foxit::addon::layoutrecognition::LRContext::LRContext | ( | const LRContext & | other | ) |

构造函数，使用另一个上下文对象。

参数

  [in] | other | 另一个上下文对象。

## 成员函数说明

## ◆ GetRootElement()

LRStructureElement foxit::addon::layoutrecognition::LRContext::GetRootElement | ( |  | ) |

获取结构树的根元素。

在调用此函数之前，请确保当前上下文对象已成功解析； 否则，无法检索有效的根结构元素。

返回
  根元素。

## ◆ IsEmpty()

bool foxit::addon::layoutrecognition::LRContext::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，意味着当前对象无用。

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

## ◆ operator!=()

bool foxit::addon::layoutrecognition::LRContext::operator!= | ( | const LRContext & | other | ) | const

不等于运算符。

参数

  [in] | other | 另一个上下文对象。此函数将检查当前对象是否不等于此对象。

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

## ◆ operator=()

LRContext& foxit::addon::layoutrecognition::LRContext::operator= | ( | const LRContext & | other | ) |

赋值运算符。

参数

  [in] | other | 另一个上下文对象，其值将被赋给当前对象。

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

## ◆ operator==()

bool foxit::addon::layoutrecognition::LRContext::operator== | ( | const LRContext & | other | ) | const

等于运算符。

参数

  [in] | other | 另一个上下文对象。此函数将检查当前对象是否等于此对象。

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

## ◆ StartParse()

common::Progressive foxit::addon::layoutrecognition::LRContext::StartParse | ( | common::PauseCallback * | pause = `0` | ) |

开始解析相关PDF页面的布局识别。

解析可能需要很长时间，所以Foxit PDF SDK使用渐进式处理过程来完成。 如果在解析过程中发生任何错误，此函数将抛出异常。 请参考类 foxit::Exception 和从 foxit::e_ErrFile 开始的值。

参数

  [in] | pause | 暂停回调对象，决定是否需要暂停解析过程。 这可以是 NULL，表示在解析过程中不暂停。 如果不是 NULL，它应该是用户实现的有效暂停对象。 默认值：NULL。

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