Inheritance diagram for foxit::addon::accessibility::AccessibilityChecker:

Public Member Functions
	AccessibilityChecker (const AccessibilityChecker &other)
	Constructor, with another checker object. More...

	AccessibilityChecker (const foxit::pdf::PDFDoc &pdf_doc)
	Constructor. More...

	~AccessibilityChecker ()
	Destructor.

bool	CanCheck ()
	Check whether the current PDF document can be full checked. More...

AccessibilityCheckResultItemData	ChangeCheckStateInResultTree (const AccessibilityCheckResultItemData &root_data, const AccessibilityCheckResultSubItemData &sub_item_data, const CheckState &new_check_state)
	Change check state in result tree. More...

String	GetTagTreeNodeIDByCheckResultItemID (int page_index, const char *item_id)
	Get tag tree node ID by check result item ID. More...

bool	IsEmpty () const
	Check whether current object is empty or not. More...

bool	operator!= (const AccessibilityChecker &other) const
	Not equal operator. More...

AccessibilityChecker &	operator= (const AccessibilityChecker &other)
	Assign operator. More...

bool	operator== (const AccessibilityChecker &other) const
	Equal operator. More...

AccessibilityCheckResultItemData	RecheckResult (AccessibilityCheckOptions check_options, const AccessibilityCheckResultItemData &root_data)
	Recheck by result root. More...

AccessibilityCheckResultItemData	RecheckResult (AccessibilityCheckOptions check_options, const AccessibilityCheckResultItemData &root_data, const AccessibilityCheckResultSubItemData &sub_item_data)
	Recheck by sub item. More...

AccessibilityCheckResultItemData	RemoveSkippedStateInResultTree (AccessibilityCheckOptions check_options, const AccessibilityCheckResultItemData &root_data, const AccessibilityCheckResultSubItemData &sub_item_data)
	Remove skipped state in result tree. More...

common::Progressive	StartCheck (AccessibilityCheckOptions check_options, foxit::common::file::StreamCallback report_callback, AccessibilityCheckResultsCallback provider, common::PauseCallback *pause)
	Start check for accessibility. More...

bool	UpdateCheckResultReport ()
	Update check result report. More...

bool	UpdateCheckState (const RuleType &rule_type, const CheckState &check_state)
	Update check state for a specified rule. More...

Public Member Functions inherited from foxit::Base
FS_HANDLE	Handle () const
	Get the handle of current object. More...

Detailed Description

This class represents an accessibility checker for a PDF document: run the full accessibility check, re-check parts of the result tree, change / remove check states and update the check result report. 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

Constructor & Destructor Documentation

◆ AccessibilityChecker() [1/2]

foxit::addon::accessibility::AccessibilityChecker::AccessibilityChecker ( const foxit::pdf::PDFDoc & pdf_doc )

explicit

Constructor.

Parameters

[in] pdf_doc A valid PDF document object.

◆ AccessibilityChecker() [2/2]

foxit::addon::accessibility::AccessibilityChecker::AccessibilityChecker ( const AccessibilityChecker & other )

Constructor, with another checker object.

Parameters

[in] other Another checker object.

Member Function Documentation

◆ CanCheck()

bool foxit::addon::accessibility::AccessibilityChecker::CanCheck ( )

Check whether the current PDF document can be full checked.

Returns: true means the document can be full checked, while false means not.

◆ ChangeCheckStateInResultTree()

AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::ChangeCheckStateInResultTree	(	const AccessibilityCheckResultItemData &	root_data,
		const AccessibilityCheckResultSubItemData &	sub_item_data,
		const CheckState &	new_check_state
	)

Change check state in result tree.

Parameters

[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.
[in]	new_check_state	The new check state.

Returns: The updated check result item data.

◆ GetTagTreeNodeIDByCheckResultItemID()

String foxit::addon::accessibility::AccessibilityChecker::GetTagTreeNodeIDByCheckResultItemID	(	int	page_index,
		const char *	item_id
	)

Get tag tree node ID by check result item ID.

Parameters

[in]	page_index	The page index.
[in]	item_id	The check result item ID.

Returns: The tag tree node ID.

◆ IsEmpty()

bool foxit::addon::accessibility::AccessibilityChecker::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::AccessibilityChecker::operator!= ( const AccessibilityChecker & other ) const

Not equal operator.

Parameters

[in] other Another checker object. This function will check if current object is not equal to this one.

Returns: true means not equal, while false means equal.

◆ operator=()

AccessibilityChecker& foxit::addon::accessibility::AccessibilityChecker::operator= ( const AccessibilityChecker & other )

Assign operator.

Parameters

[in] other Another checker object, whose value would be assigned to current object.

Returns: Reference to current object itself.

◆ operator==()

bool foxit::addon::accessibility::AccessibilityChecker::operator== ( const AccessibilityChecker & other ) const

Equal operator.

Parameters

[in] other Another checker object. This function will check if current object is equal to this one.

Returns: true means equal, while false means not equal.

◆ RecheckResult() [1/2]

AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RecheckResult	(	AccessibilityCheckOptions	check_options,
		const AccessibilityCheckResultItemData &	root_data
	)

Recheck by result root.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.

Returns: The updated check result item data.

◆ RecheckResult() [2/2]

AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RecheckResult	(	AccessibilityCheckOptions	check_options,
		const AccessibilityCheckResultItemData &	root_data,
		const AccessibilityCheckResultSubItemData &	sub_item_data
	)

Recheck by sub item.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data of check result tree.

Returns: The updated check result item data.

◆ RemoveSkippedStateInResultTree()

AccessibilityCheckResultItemData foxit::addon::accessibility::AccessibilityChecker::RemoveSkippedStateInResultTree	(	AccessibilityCheckOptions	check_options,
		const AccessibilityCheckResultItemData &	root_data,
		const AccessibilityCheckResultSubItemData &	sub_item_data
	)

Remove skipped state in result tree.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.

Returns: The updated check result item data.

◆ StartCheck()

common::Progressive foxit::addon::accessibility::AccessibilityChecker::StartCheck	(	AccessibilityCheckOptions	check_options,
		foxit::common::file::StreamCallback *	report_callback,
		AccessibilityCheckResultsCallback *	provider,
		common::PauseCallback *	pause
	)

Start check for accessibility.

Parameters

[in]	check_options	The check options. Please refer to AccessibilityCheckOptions.
[in]	report_callback	A stream callback object for report output. This can be NULL.
[in]	provider	An AccessibilityCheckResultsCallback object for check results.
[in]	pause	A pause object. This can be NULL.

Returns: A progressive object.

◆ UpdateCheckResultReport()

bool foxit::addon::accessibility::AccessibilityChecker::UpdateCheckResultReport ( )

Update check result report.

Returns: true means success, while false means not.

◆ UpdateCheckState()

bool foxit::addon::accessibility::AccessibilityChecker::UpdateCheckState	(	const RuleType &	rule_type,
		const CheckState &	check_state
	)

Update check state for a specified rule.

Parameters

[in]	rule_type	The check rule type. Please refer to values starting from addon::accessibility::e_RuleTypeDocPermission and this should be one of these values.
[in]	check_state	The check state. Please refer to values starting from addon::accessibility::e_CheckStateNone and this should be one of these values.

Returns: true means success, while false means not.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AccessibilityChecker() [1/2]

◆ AccessibilityChecker() [2/2]

Member Function Documentation

◆ CanCheck()

◆ ChangeCheckStateInResultTree()

◆ GetTagTreeNodeIDByCheckResultItemID()

◆ IsEmpty()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ RecheckResult() [1/2]

◆ RecheckResult() [2/2]

◆ RemoveSkippedStateInResultTree()

◆ StartCheck()

◆ UpdateCheckResultReport()

◆ UpdateCheckState()