foxit.addon.accessibility.AccessibilityNavigator Class Reference

Inheritance diagram for foxit.addon.accessibility.AccessibilityNavigator:

Public Types
enum	FinderType {   FinderType.e_FinderTypeInvalid = 0, FinderType.e_FinderTypeArtifacts = 1, FinderType.e_FinderTypeUnmarkedComments = 2, FinderType.e_FinderTypeUnmarkedLinks = 3,   FinderType.e_FinderTypeUnmarkedAnnots = 4, FinderType.e_FinderTypeUnmarkedContent = 5, FinderType.e_FinderTypeOcrSuspects = 6 }
	Enumeration for finder type. More...

Public Member Functions
	AccessibilityNavigator (PDFDoc pdf_doc)
	Constructor. More...
	AccessibilityNavigator (AccessibilityNavigator other)
	Constructor, with another navigator object. More...
AccessibilityFindResult	FindNextElement (int page_index, AccessibilityNavigator.FinderType find_type, bool is_search_page)
	Find next element. 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 common.Library.Initialize with a key including "Accessibility" module.

See also

foxit.common.Library

Member Enumeration Documentation

FinderType

enum foxit.addon.accessibility.AccessibilityNavigator.FinderType

strong

Enumeration for finder type.

Values of this enumeration should be used alone.

Enumerator
e_FinderTypeInvalid	Finder type: invalid.
e_FinderTypeArtifacts	Finder type: artifacts (page artifacts).
e_FinderTypeUnmarkedComments	Finder type: unmarked comments.
e_FinderTypeUnmarkedLinks	Finder type: unmarked links.
e_FinderTypeUnmarkedAnnots	Finder type: unmarked annotations.
e_FinderTypeUnmarkedContent	Finder type: unmarked page content.
e_FinderTypeOcrSuspects	Finder type: OCR suspects detected by OCR.

Constructor & Destructor Documentation

AccessibilityNavigator() [1/2]

foxit.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator ( PDFDoc  pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityNavigator() [2/2]

foxit.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator ( AccessibilityNavigator  other )

inline

Constructor, with another navigator object.

Parameters

[in]

other

Another navigator object.

Member Function Documentation

FindNextElement()

AccessibilityFindResult foxit.addon.accessibility.AccessibilityNavigator.FindNextElement ( int  page_index, AccessibilityNavigator.FinderType  find_type, bool  is_search_page  )

inline

Find next element.

Parameters

[in]	page_index	The page index.
[in]	find_type	The finder type. Please refer to values starting from foxit.addon.accessibility.AccessibilityNavigator.FinderType.e_FinderTypeInvalid and this should be one of these values.
[in]	is_search_page	Whether to search page.

Returns

The find result object.

IsEmpty()

bool foxit.addon.accessibility.AccessibilityNavigator.IsEmpty ( )

inline

Check whether current object is empty or not.

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

Returns

true means current object is empty, while false means not.

StartFindNextElement()

void foxit.addon.accessibility.AccessibilityNavigator.StartFindNextElement ( )

inline

Start to find next element.

Returns

None.

StopFindNextElement()

void foxit.addon.accessibility.AccessibilityNavigator.StopFindNextElement ( )

inline

Stop finding next element.

Returns

None.