<FSAccessibilityProviderCallback> Protocol Reference

Inherits <NSObject>.

Instance Methods
(void)	- drawLine:page_index:type:line_info_array:
	A callback function used to draw lines for accessibility visualization. More...
(void)	- drawRect:page_index:type:rect_info_array:
	A callback function used to draw rectangles for accessibility visualization. More...
(void)	- drawText:page_index:type:text_info_array:
	A callback function used to draw text for accessibility visualization. More...
(BOOL)	- generateContent:page_index:
	A callback function used to generate content for a specified page. More...
(NSString *)	- getDocumentFileName:
	A callback function used to get the document file name. More...
(NSString *)	- getTextStringByStringID:
	A callback function used to get text string by string ID. More...
(void)	- onContentChanged:page_index:is_notify_self:
	A callback function used to notify that content has changed on a specified page. More...

Detailed Description

This class represents an accessibility provider callback used to generate content and draw accessibility visualizations. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

See also

FSAccessibility

Method Documentation

drawLine:page_index:type:line_info_array:()

- (void) drawLine: (FSPDFDoc *)  pdf_doc page_index: (int)  page_index type: (FSAccessibilityProviderCallbackDrawRectType)  type line_info_array: (FSAccessibilityLineInfoArray *)  line_info_array

required

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.
[in]	line_info_array	The array of accessibility line info objects.

Returns

None.

drawRect:page_index:type:rect_info_array:()

- (void) drawRect: (FSPDFDoc *)  pdf_doc page_index: (int)  page_index type: (FSAccessibilityProviderCallbackDrawRectType)  type rect_info_array: (FSAccessibilityRectInfoArray *)  rect_info_array

required

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

Returns

None.

drawText:page_index:type:text_info_array:()

- (void) drawText: (FSPDFDoc *)  pdf_doc page_index: (int)  page_index type: (FSAccessibilityProviderCallbackDrawRectType)  type text_info_array: (FSAccessibilityTextInfoArray *)  text_info_array

required

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.
[in]	text_info_array	The array of accessibility text info objects.

Returns

None.

generateContent:page_index:()

- (BOOL) generateContent: (FSPDFDoc *)  pdf_doc page_index: (int)  page_index

required

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

YES means content generated successfully, while NO means not.

getDocumentFileName:()

- (NSString *) getDocumentFileName: (FSPDFDoc *)  pdf_doc

required

A callback function used to get the document file name.

Parameters

[in]

pdf_doc

The PDF document object.

Returns

The document file name.

getTextStringByStringID:()

- (NSString *) getTextStringByStringID: (NSString *)  string_id

required

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

Parameters

[in]

string_id

The string ID.

Returns

The text string.

onContentChanged:page_index:is_notify_self:()

- (void) onContentChanged: (FSPDFDoc *)  pdf_doc page_index: (int)  page_index is_notify_self: (BOOL)  is_notify_self

required

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.