foxit::addon::accessibility::AccessibilityNavigator Class Reference

Inheritance diagram for foxit::addon::accessibility::AccessibilityNavigator:

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

Public Member Functions
	AccessibilityNavigator (const AccessibilityNavigator &other)
	Constructor, with another navigator object. More...
	AccessibilityNavigator (const foxit::pdf::PDFDoc &pdf_doc)
	Constructor. More...
	~AccessibilityNavigator ()
	Destructor.
AccessibilityFindResult	FindNextElement (int page_index, FinderType find_type, bool is_search_page)
	Find next element. More...
bool	IsEmpty () const
	Check whether current object is empty or not. More...
bool	operator!= (const AccessibilityNavigator &other) const
	Not equal operator. More...
AccessibilityNavigator &	operator= (const AccessibilityNavigator &other)
	Assign operator. More...
bool	operator== (const AccessibilityNavigator &other) const
	Equal operator. More...
void	StartFindNextElement ()
	Start to find next element. More...
void	StopFindNextElement ()
	Stop finding next element. More...
Public Member Functions inherited from foxit::Base
FS_HANDLE	Handle () const
	Get the handle of current object. 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

common::Library

Member Enumeration Documentation

FinderType

enum foxit::addon::accessibility::AccessibilityNavigator::FinderType

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 ( const foxit::pdf::PDFDoc &  pdf_doc )

explicit

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityNavigator() [2/2]

foxit::addon::accessibility::AccessibilityNavigator::AccessibilityNavigator

(

const AccessibilityNavigator &

other

)

Constructor, with another navigator object.

Parameters

[in]

other

Another navigator object.

Member Function Documentation

FindNextElement()

AccessibilityFindResult foxit::addon::accessibility::AccessibilityNavigator::FindNextElement	(	int	page_index,
		FinderType	find_type,
		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 foxit::addon::accessibility::AccessibilityNavigator::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

(

)

const

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.

operator!=()

bool foxit::addon::accessibility::AccessibilityNavigator::operator!=

(

const AccessibilityNavigator &

other

)

const

Not equal operator.

Parameters

[in]

other

Another navigator object. This function will check if current object is not equal to this one.

Returns

true means not equal, while false means equal.

operator=()

AccessibilityNavigator& foxit::addon::accessibility::AccessibilityNavigator::operator=

(

const AccessibilityNavigator &

other

)

Assign operator.

Parameters

[in]

other

Another navigator object, whose value would be assigned to current object.

Returns

Reference to current object itself.

operator==()

bool foxit::addon::accessibility::AccessibilityNavigator::operator==

(

const AccessibilityNavigator &

other

)

const

Equal operator.

Parameters

[in]

other

Another navigator object. This function will check if current object is equal to this one.

Returns

true means equal, while false means not equal.

StartFindNextElement()

void foxit::addon::accessibility::AccessibilityNavigator::StartFindNextElement

(

)

Start to find next element.

Returns

None.

StopFindNextElement()

void foxit::addon::accessibility::AccessibilityNavigator::StopFindNextElement

(

)

Stop finding next element.

Returns

None.