fsdk.AccessibilityTextInfo Class Reference

Public Member Functions
def	GetBackground_color ()
	Get the background fill color of the text area. More...
def	GetBorder_color ()
	Get the color used of the border of the text area. More...
def	GetData_index ()
	Get index that maps this text item back to its entry in the page's reading-order data. More...
def	GetRect ()
	Get the bounding rectangle of the text content. More...
def	GetText ()
	Get the text content used for accessibility visualization. More...
def	GetText_color ()
	Get the color used of the text. More...
def	Set (text, rect, data_index, text_color, background_color, border_color)
	Set value. More...
def	SetBackground_color (value)
	Set the background fill color of the text area. More...
def	SetBorder_color (value)
	Set the color used of the border of the text area. More...
def	SetData_index (value)
	Set index that maps this text item back to its entry in the page's reading-order data. More...
def	SetRect (value)
	Set the bounding rectangle of the text content. More...
def	SetText (value)
	Set the text content used for accessibility visualization. More...
def	SetText_color (value)
	Set the color used of the text. More...

Detailed Description

This class represents accessibility text info.

Member Function Documentation

GetBackground_color()

fsdk.AccessibilityTextInfo.GetBackground_color

(

)

Get the background fill color of the text area.

Returns

The background fill color of the text area.

GetBorder_color()

fsdk.AccessibilityTextInfo.GetBorder_color

(

)

Get the color used of the border of the text area.

Returns

The color used of the border of the text area.

GetData_index()

fsdk.AccessibilityTextInfo.GetData_index

(

)

Get index that maps this text item back to its entry in the page's reading-order data.

Returns

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

GetRect()

fsdk.AccessibilityTextInfo.GetRect

(

)

Get the bounding rectangle of the text content.

Returns

The bounding rectangle of the text content.

GetText()

fsdk.AccessibilityTextInfo.GetText

(

)

Get the text content used for accessibility visualization.

Returns

The text content used for accessibility visualization.

GetText_color()

fsdk.AccessibilityTextInfo.GetText_color

(

)

Get the color used of the text.

Returns

The color used of the text.

Set()

def fsdk.AccessibilityTextInfo.Set	(		text,
			rect,
			data_index,
			text_color,
			background_color,
			border_color
	)

Set value.

Parameters

[in]	text	The text content to display for accessibility visualization.
[in]	rect	The bounding rectangle of the text content.
[in]	data_index	Index 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_color	The foreground color used to draw the text.
[in]	background_color	The background fill color of the text area.
[in]	border_color	The border color of the text area.

Returns

None.

SetBackground_color()

fsdk.AccessibilityTextInfo.SetBackground_color

(

value

)

Set the background fill color of the text area.

Parameters

[in]

value

The background fill color of the text area.

Returns

None.

SetBorder_color()

fsdk.AccessibilityTextInfo.SetBorder_color

(

value

)

Set the color used of the border of the text area.

Parameters

[in]

value

The color used of the border of the text area.

Returns

None.

SetData_index()

fsdk.AccessibilityTextInfo.SetData_index

(

value

)

Set index that maps this text item back to its entry in the page's reading-order data.

Parameters

[in]

value

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

Returns

None.

SetRect()

fsdk.AccessibilityTextInfo.SetRect

(

value

)

Set the bounding rectangle of the text content.

Parameters

[in]

value

The bounding rectangle of the text content.

Returns

None.

SetText()

fsdk.AccessibilityTextInfo.SetText

(

value

)

Set the text content used for accessibility visualization.

Parameters

[in]

value

The text content used for accessibility visualization.

Returns

None.

SetText_color()

fsdk.AccessibilityTextInfo.SetText_color

(

value

)

Set the color used of the text.

Parameters

[in]

value

The color used of the text.

Returns

None.