fsdk.AccessibilityProviderCallback Class Reference

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

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

def fsdk.AccessibilityProviderCallback.DrawLine	(		pdf_doc,
			page_index,
			type,
			line_info_array
	)

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.AccessibilityProviderCallbackE_DrawRectTypeContent and this should be one of these values..
[in]	line_info_array	The array of accessibility line info objects.

Returns

None.

DrawRect()

def fsdk.AccessibilityProviderCallback.DrawRect	(		pdf_doc,
			page_index,
			type,
			rect_info_array
	)

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.AccessibilityProviderCallbackE_DrawRectTypeContent and this should be one of these values..
[in]	rect_info_array	The array of accessibility rect info objects.

Returns

None.

DrawText()

def fsdk.AccessibilityProviderCallback.DrawText	(		pdf_doc,
			page_index,
			type,
			text_info_array
	)

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.AccessibilityProviderCallbackE_DrawRectTypeContent and this should be one of these values..
[in]	text_info_array	The array of accessibility text info objects.

Returns

None.

GenerateContent()

def fsdk.AccessibilityProviderCallback.GenerateContent	(		pdf_doc,
			page_index
	)

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

def fsdk.AccessibilityProviderCallback.GetDocumentFileName

(

pdf_doc

)

A callback function used to get the document file name.

Parameters

[in]

pdf_doc

The PDF document object.

Returns

The document file name.

GetTextStringByStringID()

def fsdk.AccessibilityProviderCallback.GetTextStringByStringID

(

string_id

)

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

Parameters

[in]

string_id

The string ID.

Returns

The text string.

OnContentChanged()

def fsdk.AccessibilityProviderCallback.OnContentChanged	(		pdf_doc,
			page_index,
			is_notify_self
	)

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

def fsdk.AccessibilityProviderCallback.Release

(

)

A callback function used to release current callback object itself.

Returns

None.