Foxit PDF SDK
foxit::addon::accessibility::AccessibilityTextInfo Class Reference

Inherits Object.

Public Member Functions

 AccessibilityTextInfo ()
 Constructor.
 
 AccessibilityTextInfo (const AccessibilityTextInfo &other)
 Constructor, with another accessibility text info object. More...
 
AccessibilityTextInfo & operator= (const AccessibilityTextInfo &other)
 Assign operator. More...
 
void Set (WString text, const RectF &rect, int data_index, foxit::RGB text_color, foxit::RGB background_color, foxit::RGB border_color)
 Set value. More...
 

Public Attributes

foxit::RGB background_color
 The background fill color of the text area.
 
foxit::RGB border_color
 The color used of the border of the text area.
 
int data_index
 Index that maps this text item back to its entry in the page's reading-order data. A non-negative value is a valid order-data index; -1 means this text item is not associated with any order data (the default).
 
foxit::RectF rect
 The bounding rectangle of the text content.
 
WString text
 The text content used for accessibility visualization.
 
foxit::RGB text_color
 The color used of the text.
 

Detailed Description

This class represents accessibility text info.

Constructor & Destructor Documentation

◆ AccessibilityTextInfo()

foxit::addon::accessibility::AccessibilityTextInfo::AccessibilityTextInfo ( const AccessibilityTextInfo &  other)
inline

Constructor, with another accessibility text info object.

Parameters
[in]otherAnother accessibility text info object whose values are copied to initialize the current object.

Member Function Documentation

◆ operator=()

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

Assign operator.

Parameters
[in]otherAnother accessibility text info object whose values are assigned to the current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::addon::accessibility::AccessibilityTextInfo::Set ( WString  text,
const RectF &  rect,
int  data_index,
foxit::RGB  text_color,
foxit::RGB  background_color,
foxit::RGB  border_color 
)
inline

Set value.

Parameters
[in]textThe text content to display for accessibility visualization.
[in]rectThe bounding rectangle of the text content.
[in]data_indexIndex that maps this text item back to its entry in the page's reading-order data. Pass a non-negative order-data index, or -1 if this text item is not associated with any order data.
[in]text_colorThe foreground color used to draw the text.
[in]background_colorThe background fill color of the text area.
[in]border_colorThe border color of the text area.
Returns
None.