FSDK.AccessibilityProviderCallback Class Reference

Public Member Functions
	DrawLine (pdf_doc, page_index, type, line_info_array)
	A callback function used to draw lines for accessibility visualization. More...
	DrawRect (pdf_doc, page_index, type, rect_info_array)
	A callback function used to draw rectangles for accessibility visualization. More...
	DrawText (pdf_doc, page_index, type, text_info_array)
	A callback function used to draw text for accessibility visualization. More...
	GenerateContent (pdf_doc, page_index)
	A callback function used to generate content for a specified page. More...
	GetDocumentFileName (pdf_doc)
	A callback function used to get the document file name. More...
	GetTextStringByStringID (string_id)
	A callback function used to get text string by string ID. More...
	OnContentChanged (pdf_doc, page_index, is_notify_self)
	A callback function used to notify that content has changed on a specified page. More...
	Release ()
	A callback function used to release current callback object itself. More...

Static Public Attributes
static	e_DrawRectTypeContent
	Enumeration for draw rect type. More...
static	e_DrawRectTypeLabel
	Draw rect type : label.
static	e_DrawRectTypeLine
	Draw rect type : line.
static	e_DrawRectTypeOrderRect
	Draw rect type : order rect.
static	e_DrawRectTypeTableCell
	Draw rect type : table cell.
static	e_DrawRectTypeTableCellsBorder
	Draw rect type : table cells border.
static	e_DrawRectTypeTableCellsDataBackground
	Draw rect type : table cells data background.
static	e_DrawRectTypeTableCellsDataBackgroundMissingHeader
	Draw rect type : table cells data background missing header.
static	e_DrawRectTypeTableCellsDataBackgroundMultispan
	Draw rect type : table cells data background multispan.
static	e_DrawRectTypeTableCellsHeaderBackground
	Draw rect type : table cells header background.
static	e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader
	Draw rect type : table cells header background missing header.
static	e_DrawRectTypeTableCellsHeaderBackgroundMultispan
	Draw rect type : table cells header background multispan.
static	e_DrawRectTypeTableCellsSelectedBorder
	Draw rect type : table cells selected border.
static	e_DrawRectTypeTableCellsType
	Draw rect type : table cells type.
static	e_DrawRectTypeTableFigure
	Draw rect type : table figure.
static	e_DrawRectTypeTableLabel
	Draw rect type : table label.
static	e_DrawRectTypeText
	Draw rect type : text.

Detailed Description

This class represents a render provider for accessibility, used to generate content and draw visual elements.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class. The render provider is shared between the accessibility classes and ReadingOrderEditor, providing rendering capabilities for accessibility visual feedback.

Member Function Documentation

DrawLine()

FSDK.AccessibilityProviderCallback.DrawLine (   pdf_doc,   page_index,   type,   line_info_array  )

inline

A callback function used to draw lines for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FSDK.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	line_info_array	The array of accessibility line info objects.

Returns

None.

DrawRect()

FSDK.AccessibilityProviderCallback.DrawRect (   pdf_doc,   page_index,   type,   rect_info_array  )

inline

A callback function used to draw rectangles for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FSDK.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	rect_info_array	The array of accessibility rect info objects.

Returns

None.

DrawText()

FSDK.AccessibilityProviderCallback.DrawText (   pdf_doc,   page_index,   type,   text_info_array  )

inline

A callback function used to draw text for accessibility visualization.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	type	The draw rect type. Please refer to values starting from FSDK.AccessibilityProviderCallback.e_DrawRectTypeContent and this should be one of these values..
[in]	text_info_array	The array of accessibility text info objects.

Returns

None.

GenerateContent()

FSDK.AccessibilityProviderCallback.GenerateContent (   pdf_doc,   page_index  )

inline

A callback function used to generate content for a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.

Returns

true means content generated successfully, while false means not.

GetDocumentFileName()

FSDK.AccessibilityProviderCallback.GetDocumentFileName (   pdf_doc )

inline

A callback function used to get the document file name.

Parameters

[in]

pdf_doc

The PDF document object.

Returns

The document file name.

GetTextStringByStringID()

FSDK.AccessibilityProviderCallback.GetTextStringByStringID (   string_id )

inline

A callback function used to get text string by string ID.

Parameters

[in]

string_id

The string ID.

Returns

The text string.

OnContentChanged()

FSDK.AccessibilityProviderCallback.OnContentChanged (   pdf_doc,   page_index,   is_notify_self  )

inline

A callback function used to notify that content has changed on a specified page.

Parameters

[in]	pdf_doc	The PDF document object.
[in]	page_index	The page index.
[in]	is_notify_self	Whether to notify self.

Returns

None.

Release()

FSDK.AccessibilityProviderCallback.Release ( )

inline

A callback function used to release current callback object itself.

Returns

None.

Member Data Documentation

e_DrawRectTypeContent

FSDK.AccessibilityProviderCallback.e_DrawRectTypeContent

static

Enumeration for draw rect type.

This enumeration is used by AccessibilityProviderCallback to specify the type of drawing rectangle. Values of this enumeration should be used alone.Draw rect type : content.