Foxit PDF SDK
FSAccessibilityTextInfo Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithOther:
 Constructor, with another accessibility text info object.
More...
 
(void) - set:rect:data_index:text_color:background_color:border_color:
 Set value.
More...
 

Properties

unsigned int background_color
 The background fill color of the text area.

 
unsigned int 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).

 
FSRectF * rect
 The bounding rectangle of the text content.

 
NSString * text
 The text content used for accessibility visualization.

 
unsigned int text_color
 The color used of the text.

 

Detailed Description

This class represents accessibility text info.

Method Documentation

◆ initWithOther:()

- (id) initWithOther: (FSAccessibilityTextInfo*)  other

Constructor, with another accessibility text info object.

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

◆ set:rect:data_index:text_color:background_color:border_color:()

- (void) set: (NSString *)  text
rect: (FSRectF*)  rect
data_index: (int)  data_index
text_color: (unsigned int)  text_color
background_color: (unsigned int)  background_color
border_color: (unsigned int)  border_color 

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.