Foxit PDF SDK
Public 类型 | Public 成员函数 | 所有成员列表
foxit::addon::accessibility::AccessibilityProviderCallback类 参考abstract

Public 类型

enum  DrawRectType {
  e_DrawRectTypeContent = 0, e_DrawRectTypeTableCell = 1, e_DrawRectTypeTableFigure = 2, e_DrawRectTypeOrderRect = 3,
  e_DrawRectTypeText = 4, e_DrawRectTypeTableLabel = 5, e_DrawRectTypeLine = 6, e_DrawRectTypeLabel = 7,
  e_DrawRectTypeTableCellsType = 8, e_DrawRectTypeTableCellsBorder = 9, e_DrawRectTypeTableCellsSelectedBorder = 10, e_DrawRectTypeTableCellsHeaderBackground = 11,
  e_DrawRectTypeTableCellsDataBackground = 12, e_DrawRectTypeTableCellsHeaderBackgroundMultispan = 13, e_DrawRectTypeTableCellsDataBackgroundMultispan = 14, e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader = 15,
  e_DrawRectTypeTableCellsDataBackgroundMissingHeader = 16
}
 绘制矩形类型枚举。 更多...
 

Public 成员函数

virtual void DrawLine (const foxit::pdf::PDFDoc &pdf_doc, int page_index, DrawRectType type, const AccessibilityLineInfoArray &line_info_array)=0
 用于为可访问性可视化绘制线条的回调函数。 更多...
 
virtual void DrawRect (const foxit::pdf::PDFDoc &pdf_doc, int page_index, DrawRectType type, const AccessibilityRectInfoArray &rect_info_array)=0
 用于为可访问性可视化绘制矩形的回调函数。 更多...
 
virtual void DrawText (const foxit::pdf::PDFDoc &pdf_doc, int page_index, DrawRectType type, const AccessibilityTextInfoArray &text_info_array)=0
 用于为可访问性可视化绘制文本的回调函数。 更多...
 
virtual bool GenerateContent (const foxit::pdf::PDFDoc &pdf_doc, int page_index)=0
 用于为指定页面生成内容的回调函数。 更多...
 
virtual WString GetDocumentFileName (const foxit::pdf::PDFDoc &pdf_doc)=0
 用于获取文档文件名的回调函数。 更多...
 
virtual WString GetTextStringByStringID (const WString &string_id)=0
 用于根据字符串 ID 获取文本字符串的回调函数。 更多...
 
virtual void OnContentChanged (const foxit::pdf::PDFDoc &pdf_doc, int page_index, bool is_notify_self)=0
 用于通知指定页面内容已发生变化的回调函数。 更多...
 
virtual void Release ()=0
 用于释放当前回调对象本身的回调函数。 更多...
 

详细描述

此类表示用于可访问性的渲染提供者，用于生成内容并绘制可视化元素。

本类中的所有纯虚函数都作为回调函数使用，应在派生类中由用户实现。该渲染提供者 在可访问性相关类与 ReadingOrderEditor 之间共享，为可访问性可视化反馈提供渲染能力。

成员枚举类型说明

◆ DrawRectType

enum foxit::addon::accessibility::AccessibilityProviderCallback::DrawRectType

绘制矩形类型枚举。

此枚举由 AccessibilityProviderCallback 用于指定绘制矩形的类型。 此枚举的值应单独使用。

枚举值
e_DrawRectTypeContent 

绘制矩形类型：内容。

e_DrawRectTypeTableCell 

绘制矩形类型：表格单元格。

e_DrawRectTypeTableFigure 

绘制矩形类型：表格图形。

e_DrawRectTypeOrderRect 

绘制矩形类型：顺序矩形。

e_DrawRectTypeText 

绘制矩形类型：文本。

e_DrawRectTypeTableLabel 

绘制矩形类型：表格标签。

e_DrawRectTypeLine 

绘制矩形类型：线条。

e_DrawRectTypeLabel 

绘制矩形类型：标签。

e_DrawRectTypeTableCellsType 

绘制矩形类型：表格单元格类型。

e_DrawRectTypeTableCellsBorder 

绘制矩形类型：表格单元格边框。

e_DrawRectTypeTableCellsSelectedBorder 

绘制矩形类型：表格单元格选中边框。

e_DrawRectTypeTableCellsHeaderBackground 

绘制矩形类型：表格单元格表头背景。

e_DrawRectTypeTableCellsDataBackground 

绘制矩形类型：表格单元格数据背景。

e_DrawRectTypeTableCellsHeaderBackgroundMultispan 

绘制矩形类型：表格单元格表头背景（多重合并）。

e_DrawRectTypeTableCellsDataBackgroundMultispan 

绘制矩形类型：表格单元格数据背景（多重合并）。

e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader 

绘制矩形类型：表格单元格表头背景（缺失表头）。

e_DrawRectTypeTableCellsDataBackgroundMissingHeader 

绘制矩形类型：表格单元格数据背景（缺失表头）。

成员函数说明

◆ DrawLine()

virtual void foxit::addon::accessibility::AccessibilityProviderCallback::DrawLine ( const foxit::pdf::PDFDoc &  pdf_doc,
int  page_index,
DrawRectType  type,
const AccessibilityLineInfoArray &  line_info_array 
)
pure virtual

用于为可访问性可视化绘制线条的回调函数。

参数
[in]pdf_docPDF 文档对象。
[in]page_index页面索引。
[in]type绘制矩形类型。请参考从 foxit::addon::accessibility::AccessibilityProviderCallback::e_DrawRectTypeContent 开始的值， 本参数应为其中之一。
[in]line_info_array可访问性线条信息对象的数组。
返回
无。

◆ DrawRect()

virtual void foxit::addon::accessibility::AccessibilityProviderCallback::DrawRect ( const foxit::pdf::PDFDoc &  pdf_doc,
int  page_index,
DrawRectType  type,
const AccessibilityRectInfoArray &  rect_info_array 
)
pure virtual

用于为可访问性可视化绘制矩形的回调函数。

参数
[in]pdf_docPDF 文档对象。
[in]page_index页面索引。
[in]type绘制矩形类型。请参考从 foxit::addon::accessibility::AccessibilityProviderCallback::e_DrawRectTypeContent 开始的值， 本参数应为其中之一。
[in]rect_info_array可访问性矩形信息对象的数组。
返回
无。

◆ DrawText()

virtual void foxit::addon::accessibility::AccessibilityProviderCallback::DrawText ( const foxit::pdf::PDFDoc &  pdf_doc,
int  page_index,
DrawRectType  type,
const AccessibilityTextInfoArray &  text_info_array 
)
pure virtual

用于为可访问性可视化绘制文本的回调函数。

参数
[in]pdf_docPDF 文档对象。
[in]page_index页面索引。
[in]type绘制矩形类型。请参考从 foxit::addon::accessibility::AccessibilityProviderCallback::e_DrawRectTypeContent 开始的值， 本参数应为其中之一。
[in]text_info_array可访问性文本信息对象的数组。
返回
无。

◆ GenerateContent()

virtual bool foxit::addon::accessibility::AccessibilityProviderCallback::GenerateContent ( const foxit::pdf::PDFDoc &  pdf_doc,
int  page_index 
)
pure virtual

用于为指定页面生成内容的回调函数。

参数
[in]pdf_docPDF 文档对象。
[in]page_index页面索引。
返回
true 表示内容生成成功，false 表示失败。

◆ GetDocumentFileName()

virtual WString foxit::addon::accessibility::AccessibilityProviderCallback::GetDocumentFileName ( const foxit::pdf::PDFDoc &  pdf_doc)
pure virtual

用于获取文档文件名的回调函数。

参数
[in]pdf_docPDF 文档对象。
返回
文档文件名。

◆ GetTextStringByStringID()

virtual WString foxit::addon::accessibility::AccessibilityProviderCallback::GetTextStringByStringID ( const WString &  string_id)
pure virtual

用于根据字符串 ID 获取文本字符串的回调函数。

参数
[in]string_id字符串 ID。
返回
文本字符串。

◆ OnContentChanged()

virtual void foxit::addon::accessibility::AccessibilityProviderCallback::OnContentChanged ( const foxit::pdf::PDFDoc &  pdf_doc,
int  page_index,
bool  is_notify_self 
)
pure virtual

用于通知指定页面内容已发生变化的回调函数。

参数
[in]pdf_docPDF 文档对象。
[in]page_index页面索引。
[in]is_notify_self是否通知自身。
返回
无。

◆ Release()

virtual void foxit::addon::accessibility::AccessibilityProviderCallback::Release ( )
pure virtual

用于释放当前回调对象本身的回调函数。

返回
无。