foxit::addon::accessibility::AccessibilityChecker类 参考
类 foxit::addon::accessibility::AccessibilityChecker 继承关系图:
Public 成员函数 继承自 详细描述
此类表示用于 PDF 文档的可访问性检查器：执行完整的可访问性 检查、对结果树的部分内容重新检查、更改/移除检查状态以及更新检查 结果报告。 在使用此模块中的任何类或方法之前，请确保已通过 common::Library::Initialize 函数并使用包含 "Accessibility" 模块的密钥成功初始化福昕 PDF SDK。
构造及析构函数说明
◆ AccessibilityChecker() [1/2]
|
explicit |
构造函数。
- 参数
-
[in] pdf_doc 有效的 PDF 文档对象。
◆ AccessibilityChecker() [2/2]
| foxit::addon::accessibility::AccessibilityChecker::AccessibilityChecker | ( | const AccessibilityChecker & | other | ) |
构造函数，使用另一个检查器对象构造。
- 参数
-
[in] other 另一个检查器对象。
成员函数说明
◆ CanCheck()
| bool foxit::addon::accessibility::AccessibilityChecker::CanCheck | ( | ) |
检查当前 PDF 文档是否可以进行完整检查。
- 返回
- true 表示该文档可以进行完整检查，false 表示不可以。
◆ ChangeCheckStateInResultTree()
| AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::ChangeCheckStateInResultTree | ( | const AccessibilityCheckResultItemData & | root_data, |
| const AccessibilityCheckResultSubItemData & | sub_item_data, | ||
| const CheckState & | new_check_state | ||
| ) |
更改结果树中的检查状态。
- 参数
-
[in] root_data 检查结果树的根数据。 [in] sub_item_data 子项数据。 [in] new_check_state 新的检查状态。
- 返回
- 更新后的检查结果项数据。
◆ GetTagTreeNodeIDByCheckResultItemID()
| String foxit::addon::accessibility::AccessibilityChecker::GetTagTreeNodeIDByCheckResultItemID | ( | int | page_index, |
| const char * | item_id | ||
| ) |
根据检查结果项 ID 获取标签树节点 ID。
- 参数
-
[in] page_index 页面索引。 [in] item_id 检查结果项 ID。
- 返回
- 标签树节点 ID。
◆ IsEmpty()
| bool foxit::addon::accessibility::AccessibilityChecker::IsEmpty | ( | ) | const |
检查当前对象是否为空。
当前对象为空时，表示当前对象不可用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ operator!=()
| bool foxit::addon::accessibility::AccessibilityChecker::operator!= | ( | const AccessibilityChecker & | other | ) | const |
不等于操作符。
- 参数
-
[in] other 另一个检查器对象。此函数将检查当前对象是否与该对象不相等。
- 返回
- true 表示不相等，false 表示相等。
◆ operator=()
| AccessibilityChecker& foxit::addon::accessibility::AccessibilityChecker::operator= | ( | const AccessibilityChecker & | other | ) |
赋值操作符。
- 参数
-
[in] other 另一个检查器对象，其值将被赋值给当前对象。
- 返回
- 当前对象自身的引用。
◆ operator==()
| bool foxit::addon::accessibility::AccessibilityChecker::operator== | ( | const AccessibilityChecker & | other | ) | const |
等于操作符。
- 参数
-
[in] other 另一个检查器对象。此函数将检查当前对象是否与该对象相等。
- 返回
- true 表示相等，false 表示不相等。
◆ RecheckResult() [1/2]
| AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RecheckResult | ( | AccessibilityCheckOptions | check_options, |
| const AccessibilityCheckResultItemData & | root_data | ||
| ) |
按结果根节点重新检查。
- 参数
-
[in] check_options 检查选项。 [in] root_data 检查结果树的根数据。
- 返回
- 更新后的检查结果项数据。
◆ RecheckResult() [2/2]
| AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RecheckResult | ( | AccessibilityCheckOptions | check_options, |
| const AccessibilityCheckResultItemData & | root_data, | ||
| const AccessibilityCheckResultSubItemData & | sub_item_data | ||
| ) |
按子项重新检查。
- 参数
-
[in] check_options 检查选项。 [in] root_data 检查结果树的根数据。 [in] sub_item_data 检查结果树的子项数据。
- 返回
- 更新后的检查结果项数据。
◆ RemoveSkippedStateInResultTree()
| AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RemoveSkippedStateInResultTree | ( | AccessibilityCheckOptions | check_options, |
| const AccessibilityCheckResultItemData & | root_data, | ||
| const AccessibilityCheckResultSubItemData & | sub_item_data | ||
| ) |
移除结果树中的"已跳过"状态。
- 参数
-
[in] check_options 检查选项。 [in] root_data 检查结果树的根数据。 [in] sub_item_data 子项数据。
- 返回
- 更新后的检查结果项数据。
◆ StartCheck()
| common::Progressive foxit::addon::accessibility::AccessibilityChecker::StartCheck | ( | AccessibilityCheckOptions | check_options, |
| foxit::common::file::StreamCallback * | report_callback, | ||
| AccessibilityCheckResultsCallback * | provider, | ||
| common::PauseCallback * | pause | ||
| ) |
开始进行可访问性检查。
- 参数
-
[in] check_options 检查选项。请参考 AccessibilityCheckOptions。 [in] report_callback 用于报告输出的流回调对象。此参数可为 NULL。 [in] provider 用于获取检查结果的 AccessibilityCheckResultsCallback 对象。 [in] pause 暂停对象。此参数可为 NULL。
- 返回
- 一个渐进式（Progressive）对象。
◆ UpdateCheckResultReport()
| bool foxit::addon::accessibility::AccessibilityChecker::UpdateCheckResultReport | ( | ) |
更新检查结果报告。
- 返回
- true 表示成功，false 表示失败。
◆ UpdateCheckState()
| bool foxit::addon::accessibility::AccessibilityChecker::UpdateCheckState | ( | const RuleType & | rule_type, |
| const CheckState & | check_state | ||
| ) |
更新指定规则的检查状态。
- 参数
-
[in] rule_type 检查规则类型。请参考从 addon::accessibility::e_RuleTypeDocPermission 开始的值，本参数应为其中之一。 [in] check_state 检查状态。请参考从 addon::accessibility::e_CheckStateNone 开始的值，本参数应为其中之一。
- 返回
- true 表示成功，false 表示失败。
