FSAccessibilityNavigator Class Reference

Inheritance diagram for FSAccessibilityNavigator:

Instance Methods
(FSAccessibilityFindResult *)	- findNextElement:find_type:is_search_page:
	Find next element. More...
(id)	- initWithOther:
	Constructor, with another navigator object. More...
(id)	- initWithPdf_doc:
	Constructor. More...
(BOOL)	- isEmpty
	Check whether current object is empty or not. More...
(void)	- startFindNextElement
	Start to find next element. More...
(void)	- stopFindNextElement
	Stop finding next element. More...

Detailed Description

This class lets user walk through the accessible elements of a PDF document one by one, used to drive "find next element" navigation in an accessibility checking / fixing UI. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FSLibrary::initialize:key: with a key including "Accessibility" module.

See also

FSLibrary

Method Documentation

findNextElement:find_type:is_search_page:()

- (FSAccessibilityFindResult *) findNextElement:		(int)	page_index
find_type:		(FSAccessibilityNavigatorFinderType)	find_type
is_search_page:		(BOOL)	is_search_page

Find next element.

Parameters

[in]	page_index	The page index.
[in]	find_type	The finder type. Please refer to values starting from FSAccessibilityNavigatorFinderTypeInvalid and this should be one of these values.
[in]	is_search_page	Whether to search page.

Returns

The find result object.

initWithOther:()

- (id) initWithOther:

(FSAccessibilityNavigator*)

other

Constructor, with another navigator object.

Parameters

[in]

other

Another navigator object.

initWithPdf_doc:()

- (id) initWithPdf_doc:

(FSPDFDoc*)

pdf_doc

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

isEmpty()

- (BOOL) isEmpty

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

YES means current object is empty, while NO means not.

startFindNextElement()

- (void) startFindNextElement

Start to find next element.

Returns

None.

stopFindNextElement()

- (void) stopFindNextElement

Stop finding next element.

Returns

None.