Foxit PDF SDK
foxit::addon::accessibility::AutoTagProviderCallback类 参考abstract

表示用于可访问性自动标记结果的提供者回调对象。 更多...

Public 类型

enum  AutoTagResultDataType {
  e_AutoTagResultDataTypeReduceConfidence = 0, e_AutoTagResultDataTypeTagreportPrepage = 1, e_AutoTagResultDataTypeTagreportNextpage = 2, e_AutoTagResultDataTypePage = 3,
  e_AutoTagResultDataTypeRegions = 4, e_AutoTagResultDataTypeArtifacts = 5, e_AutoTagResultDataTypeParagraphs = 6, e_AutoTagResultDataTypeListItem = 7,
  e_AutoTagResultDataTypeFigures = 8, e_AutoTagResultDataTypeTables = 9, e_AutoTagResultDataTypeTableRow = 10, e_AutoTagResultDataTypeTableHeader = 11,
  e_AutoTagResultDataTypeToc = 12, e_AutoTagResultDataTypeHighConfidence = 13, e_AutoTagResultDataTypeMediumhighConfidence = 14, e_AutoTagResultDataTypeMediumConfidence = 15,
  e_AutoTagResultDataTypeMediumlowConfidence = 16, e_AutoTagResultDataTypeLowConfidence = 17, e_AutoTagResultDataTypeCheckCategory = 18, e_AutoTagResultDataTypeFixCategory = 19,
  e_AutoTagResultDataTypeHintRegion = 20, e_AutoTagResultDataTypeHintArtifacts = 21, e_AutoTagResultDataTypeHintParagraph = 22, e_AutoTagResultDataTypeHintList = 23,
  e_AutoTagResultDataTypeHintFigure = 24, e_AutoTagResultDataTypeHintTables = 25, e_AutoTagResultDataTypeHintTableRow = 26, e_AutoTagResultDataTypeHintTableHeader = 27,
  e_AutoTagResultDataTypeHintToc = 28, e_AutoTagResultDataTypeHintRepair = 29, e_AutoTagResultDataTypeTouchupReadingOrder = 30, e_AutoTagResultDataTypeAlttext = 31,
  e_AutoTagResultDataTypeHintAlttext = 32, e_AutoTagResultDataTypeCheckerTable5 = 33, e_AutoTagResultDataTypeIntroduction = 34, e_AutoTagResultDataTypeSumReduceConfidence = 35,
  e_AutoTagResultDataTypeRibbonCategory = 36, e_AutoTagResultDataTypeSumAlttextFigure = 37, e_AutoTagResultDataTypeTagrepIntroduction = 38, e_AutoTagResultDataTypeMissFigure = 39,
  e_AutoTagResultDataTypeTagreportFilename = 40, e_AutoTagResultDataTypeBacktotop = 41
}
 自动标记(accessibility auto tag)结果数据类型的枚举。 更多...
 

Public 成员函数

virtual foxit::WString GetReportText (AutoTagResultDataType type)=0
 获取指定自动标记结果数据类型的显示文本。 更多...
 

详细描述

表示用于可访问性自动标记结果的提供者回调对象。

本类中的所有纯虚函数都作为回调使用,应在派生类中由用户实现。

成员枚举类型说明

◆ AutoTagResultDataType

自动标记(accessibility auto tag)结果数据类型的枚举。

此枚举的值应单独使用。

枚举值
e_AutoTagResultDataTypeReduceConfidence 

自动标记结果数据类型:降低置信度。

e_AutoTagResultDataTypeTagreportPrepage 

自动标记结果数据类型:标记报告上一页。

e_AutoTagResultDataTypeTagreportNextpage 

自动标记结果数据类型:标记报告下一页。

e_AutoTagResultDataTypePage 

自动标记结果数据类型:页面。

e_AutoTagResultDataTypeRegions 

自动标记结果数据类型:区域集合。

e_AutoTagResultDataTypeArtifacts 

自动标记结果数据类型:人工元素集合(Artifacts)。

e_AutoTagResultDataTypeParagraphs 

自动标记结果数据类型:段落集合。

e_AutoTagResultDataTypeListItem 

自动标记结果数据类型:列表项。

e_AutoTagResultDataTypeFigures 

自动标记结果数据类型:图形集合。

e_AutoTagResultDataTypeTables 

自动标记结果数据类型:表格集合。

e_AutoTagResultDataTypeTableRow 

自动标记结果数据类型:表格行。

e_AutoTagResultDataTypeTableHeader 

自动标记结果数据类型:表格表头。

e_AutoTagResultDataTypeToc 

自动标记结果数据类型:目录(TOC)。

e_AutoTagResultDataTypeHighConfidence 

自动标记结果数据类型:高置信度。

e_AutoTagResultDataTypeMediumhighConfidence 

自动标记结果数据类型:中高置信度。

e_AutoTagResultDataTypeMediumConfidence 

自动标记结果数据类型:中等置信度。

e_AutoTagResultDataTypeMediumlowConfidence 

自动标记结果数据类型:中低置信度。

e_AutoTagResultDataTypeLowConfidence 

自动标记结果数据类型:低置信度。

e_AutoTagResultDataTypeCheckCategory 

自动标记结果数据类型:检查类别。

e_AutoTagResultDataTypeFixCategory 

自动标记结果数据类型:修复类别。

e_AutoTagResultDataTypeHintRegion 

自动标记结果数据类型:提示区域。

e_AutoTagResultDataTypeHintArtifacts 

自动标记结果数据类型:提示人工元素。

e_AutoTagResultDataTypeHintParagraph 

自动标记结果数据类型:提示段落。

e_AutoTagResultDataTypeHintList 

自动标记结果数据类型:提示列表。

e_AutoTagResultDataTypeHintFigure 

自动标记结果数据类型:提示图形。

e_AutoTagResultDataTypeHintTables 

自动标记结果数据类型:提示表格。

e_AutoTagResultDataTypeHintTableRow 

自动标记结果数据类型:提示表格行。

e_AutoTagResultDataTypeHintTableHeader 

自动标记结果数据类型:提示表格表头。

e_AutoTagResultDataTypeHintToc 

自动标记结果数据类型:提示目录(TOC)。

e_AutoTagResultDataTypeHintRepair 

自动标记结果数据类型:提示修复。

e_AutoTagResultDataTypeTouchupReadingOrder 

自动标记结果数据类型:微调阅读顺序。

e_AutoTagResultDataTypeAlttext 

自动标记结果数据类型:替代文本(alttext)。

e_AutoTagResultDataTypeHintAlttext 

自动标记结果数据类型:替代文本提示。

e_AutoTagResultDataTypeCheckerTable5 

自动标记结果数据类型:检查器表格5。

e_AutoTagResultDataTypeIntroduction 

自动标记结果数据类型:引言/介绍。

e_AutoTagResultDataTypeSumReduceConfidence 

自动标记结果数据类型:降低置信度汇总。

e_AutoTagResultDataTypeRibbonCategory 

自动标记结果数据类型:功能区(Ribbon)类别。

e_AutoTagResultDataTypeSumAlttextFigure 

自动标记结果数据类型:图像替代文本汇总。

e_AutoTagResultDataTypeTagrepIntroduction 

自动标记结果数据类型:标记报告简介。

e_AutoTagResultDataTypeMissFigure 

自动标记结果数据类型:缺失图像。

e_AutoTagResultDataTypeTagreportFilename 

自动标记结果数据类型:标记报告文件名。

e_AutoTagResultDataTypeBacktotop 

自动标记结果数据类型:返回顶部。

成员函数说明

◆ GetReportText()

virtual foxit::WString foxit::addon::accessibility::AutoTagProviderCallback::GetReportText ( AutoTagResultDataType  type)
pure virtual

获取指定自动标记结果数据类型的显示文本。

该回调在 SDK 生成”添加标记(Add Tags)”报告(自动标记过程中)时被调用。对于从 AutoTagProviderCallback::AutoTagResultDataType::e_AutoTagResultDataTypeReduceConfidence 开始的每个值,SDK 都会向应用请求对应的 (通常是本地化的)显示字符串,因此报告中所有面向用户的文案均由应用控制。

大多数类型对应一个普通标签(例如 "Figures"、"Artifacts"、"Table Summary")。少数类型要求 返回的字符串中包含 printf 风格的占位符,SDK 会在运行时进行替换;实现时必须保留占位符及其顺序:

  • %d 页码(从 1 开始):e_AutoTagResultDataTypePage("Page %d")、 e_AutoTagResultDataTypeMissFigure("Figure missing AltText on page %d.");
  • %d 数量:e_AutoTagResultDataTypeSumReduceConfidence("%d reduced confidence pages")、 e_AutoTagResultDataTypeSumAlttextFigure("%d figures missing AltText");
  • %ls 类别名称:e_AutoTagResultDataTypeCheckCategory("%ls to check.")、 e_AutoTagResultDataTypeFixCategory("How to Fix %ls Tagging.");
  • %ls 文件名:e_AutoTagResultDataTypeTagreportFilename("Add Tags Report for %ls")。

对于未知或未处理的类型,请返回空字符串。完整的参考实现可见无障碍单元测试类 CFSUT_AutoTagProviderCallbackImpl。

参数
[in]type从 AutoTagProviderCallback::AutoTagResultDataType::e_AutoTagResultDataTypeReduceConfidence 开始的值之一,SDK 正在请求其显示文本。
返回
type 对应的显示文本(可能包含上述占位符);若该类型未处理,返回空字符串。