Foxit PDF SDK
foxit::addon::accessibility::AlternateTextFigureData类 参考

图像替代文本信息的数据结构。 更多...

继承自 Object .

Public 成员函数

 AlternateTextFigureData ()
 默认构造函数:创建一个空的、非装饰性图像条目。
 
 AlternateTextFigureData (bool is_decorative_figure, const wchar_t *alternate_text, const wchar_t *alternate_text_changed, int page_index, foxit::RectF rect)
 使用显式值构造。 更多...
 
 AlternateTextFigureData (const AlternateTextFigureData &other)
 拷贝构造函数。
 
AlternateTextFigureData & operator= (const AlternateTextFigureData &other)
 赋值操作符。 更多...
 
void Set (bool is_decorative_figure, const wchar_t *alternate_text, const wchar_t *alternate_text_changed, int page_index, foxit::RectF rect)
 一次性设置对象的所有值。 更多...
 

Public 属性

WString alternate_text
 更改前的替代文本(原始)。
 
WString alternate_text_changed
 更改后的替代文本(修复模式下修改)。
 
bool is_decorative_figure
 是否为装饰性图像(无替代文本)。
 
int page_index
 图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf::PDFDoc::GetPageCount 返回的页面总数。
 
foxit::RectF rect
 图像在页面上的边界矩形。
 

详细描述

图像替代文本信息的数据结构。

存储在无障碍标记与修复工作流中使用的单个图像信息。

  • is_decorative_figure:指示图像是否为装饰性图像(若为装饰性则不应设置替代文本)。
  • alternate_text:原始替代文本(编辑前)。
  • alternate_text_changed:用户修改后的替代文本(修复模式下使用)。
  • page_index:图像所在的零基页面索引。
  • rect:图像在页面上的边界矩形。

典型用法:

  1. 使用 TaggedPDF::GetNextFigureData() / GetPrevFigureData() 迭代。
  2. 使用 SetCurrentFigureDataInfo() 修改并通过 TaggedPDF::SaveFigureData() 保存。

构造及析构函数说明

◆ AlternateTextFigureData()

foxit::addon::accessibility::AlternateTextFigureData::AlternateTextFigureData ( bool  is_decorative_figure,
const wchar_t *  alternate_text,
const wchar_t *  alternate_text_changed,
int  page_index,
foxit::RectF  rect 
)
inline

使用显式值构造。

参数
[in]is_decorative_figure若为 true 则表示图像为装饰性(无需替代文本)。
[in]alternate_text原始替代文本(可为 null/空)。
[in]alternate_text_changed修改后的替代文本(可为 null/空)。
[in]page_index图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf::PDFDoc::GetPageCount 返回的页面总数。
[in]rect图像在页面上的边界矩形。

成员函数说明

◆ operator=()

AlternateTextFigureData& foxit::addon::accessibility::AlternateTextFigureData::operator= ( const AlternateTextFigureData &  other)
inline

赋值操作符。

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

◆ Set()

void foxit::addon::accessibility::AlternateTextFigureData::Set ( bool  is_decorative_figure,
const wchar_t *  alternate_text,
const wchar_t *  alternate_text_changed,
int  page_index,
foxit::RectF  rect 
)
inline

一次性设置对象的所有值。

参数
[in]is_decorative_figure是否为装饰性图像。
[in]alternate_text原始替代文本。
[in]alternate_text_changed修改后的替代文本。
[in]page_index图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf::PDFDoc::GetPageCount 返回的页面总数。
[in]rect图像的边界矩形。