foxit::addon::accessibility::AccessibilityFixer Class Reference

Inheritance diagram for foxit::addon::accessibility::AccessibilityFixer:

Public Member Functions
	AccessibilityFixer (const foxit::pdf::PDFDoc &pdf_doc)
	Constructor. More...
	AccessibilityFixer (const AccessibilityFixer &other)
	Constructor, with another fixer object. More...
	~AccessibilityFixer ()
	Destructor.
bool	CanFixPermissionRules (const RuleType &check_rule, bool is_ocr_enabled)
	Check whether permission rules can be fixed. More...
bool	CanFixRules (const RuleType &check_rule, const CheckState &check_state)
	Check whether specified rules can be fixed. More...
bool	FixDocumentBookmark (const WStringArray &roles_array)
	Fix document bookmark. More...
bool	FixDocumentLanguage (const wchar_t *lang)
	Fix document language. More...
bool	FixDocumentPermission ()
	Fix document permission. More...
bool	FixDocumentTag ()
	Fix document tag. More...
bool	FixDocumentTitle (const wchar_t *title, const wchar_t *subject, const wchar_t *author, const wchar_t *keywords)
	Fix document title. More...
WString	FixDocumentTitleWithExistingTitle ()
	Fix document title with existing title. More...
bool	FixFigureAltText (const AccessibilityCheckResultDetailDataArray &detail_data_array)
	Fix figure alternate text. More...
bool	FixFormFieldDescriptions ()
	Fix form field descriptions. More...
bool	FixFormFieldTagged ()
	Fix form field tagged. More...
bool	FixPageTabOrder ()
	Fix page tab order. More...
bool	IsEmpty () const
	Check whether current object is empty or not. More...
bool	operator!= (const AccessibilityFixer &other) const
	Not equal operator. More...
AccessibilityFixer &	operator= (const AccessibilityFixer &other)
	Assign operator. More...
bool	operator== (const AccessibilityFixer &other) const
	Equal operator. 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 fixer for a PDF document: query whether rules are fixable and apply automatic fixes (document language / title / bookmark / permission / tag, page tab order, figure alternate text, form field tagging and descriptions). 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

AccessibilityFixer() [1/2]

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

explicit

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityFixer() [2/2]

foxit::addon::accessibility::AccessibilityFixer::AccessibilityFixer

(

const AccessibilityFixer &

other

)

Constructor, with another fixer object.

Parameters

[in]

other

Another fixer object.

Member Function Documentation

CanFixPermissionRules()

bool foxit::addon::accessibility::AccessibilityFixer::CanFixPermissionRules	(	const RuleType &	check_rule,
		bool	is_ocr_enabled
	)

Check whether permission rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	is_ocr_enabled	Whether OCR is enabled.

Returns

true means permission rules can be fixed, while false means not.

CanFixRules()

bool foxit::addon::accessibility::AccessibilityFixer::CanFixRules	(	const RuleType &	check_rule,
		const CheckState &	check_state
	)

Check whether specified rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	check_state	The check state.

Returns

true means the rules can be fixed, while false means not.

FixDocumentBookmark()

bool foxit::addon::accessibility::AccessibilityFixer::FixDocumentBookmark

(

const WStringArray &

roles_array

)

Fix document bookmark.

Parameters

[in]

roles_array

The roles array.

Returns

true means success, while false means not.

FixDocumentLanguage()

bool foxit::addon::accessibility::AccessibilityFixer::FixDocumentLanguage

(

const wchar_t *

lang

)

Fix document language.

Parameters

[in]

lang

The language to set.

Returns

true means success, while false means not.

FixDocumentPermission()

bool foxit::addon::accessibility::AccessibilityFixer::FixDocumentPermission

(

)

Fix document permission.

Returns

true means success, while false means not.

FixDocumentTag()

bool foxit::addon::accessibility::AccessibilityFixer::FixDocumentTag

(

)

Fix document tag.

Returns

true means success, while false means not.

FixDocumentTitle()

bool foxit::addon::accessibility::AccessibilityFixer::FixDocumentTitle	(	const wchar_t *	title,
		const wchar_t *	subject,
		const wchar_t *	author,
		const wchar_t *	keywords
	)

Fix document title.

Parameters

[in]	title	The title to set.
[in]	subject	The subject to set.
[in]	author	The author to set.
[in]	keywords	The keywords to set.

Returns

true means success, while false means not.

FixDocumentTitleWithExistingTitle()

WString foxit::addon::accessibility::AccessibilityFixer::FixDocumentTitleWithExistingTitle

(

)

Fix document title with existing title.

Returns

The existing title text.

FixFigureAltText()

bool foxit::addon::accessibility::AccessibilityFixer::FixFigureAltText

(

const AccessibilityCheckResultDetailDataArray &

detail_data_array

)

Fix figure alternate text.

Parameters

[in]

detail_data_array

The check result detail data array.

Returns

true means success, while false means not.

FixFormFieldDescriptions()

bool foxit::addon::accessibility::AccessibilityFixer::FixFormFieldDescriptions

(

)

Fix form field descriptions.

Returns

true means success, while false means not.

FixFormFieldTagged()

bool foxit::addon::accessibility::AccessibilityFixer::FixFormFieldTagged

(

)

Fix form field tagged.

Returns

true means success, while false means not.

FixPageTabOrder()

bool foxit::addon::accessibility::AccessibilityFixer::FixPageTabOrder

(

)

Fix page tab order.

Returns

true means success, while false means not.

IsEmpty()

bool foxit::addon::accessibility::AccessibilityFixer::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::AccessibilityFixer::operator!=

(

const AccessibilityFixer &

other

)

const

Not equal operator.

Parameters

[in]

other

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

Returns

true means not equal, while false means equal.

operator=()

AccessibilityFixer& foxit::addon::accessibility::AccessibilityFixer::operator=

(

const AccessibilityFixer &

other

)

Assign operator.

Parameters

[in]

other

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

Returns

Reference to current object itself.

operator==()

bool foxit::addon::accessibility::AccessibilityFixer::operator==

(

const AccessibilityFixer &

other

)

const

Equal operator.

Parameters

[in]

other

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

Returns

true means equal, while false means not equal.