foxit::addon::accessibility::AccessibilityCheckOptions Class Reference

Inherits Object.

Public Types
enum	CheckValidateRuleType {   e_CheckValidateRuleTypeDocPermission = 0x0101, e_CheckValidateRuleTypeDocPureImage = 0x0102, e_CheckValidateRuleTypeDocTagged = 0x0103, e_CheckValidateRuleTypeDocStructTreeOrder = 0x0104,   e_CheckValidateRuleTypeDocLanguageSpecified = 0x0105, e_CheckValidateRuleTypeDocTitle = 0x0106, e_CheckValidateRuleTypeDocOutlineForLarge = 0x0107, e_CheckValidateRuleTypeDocColorContrast = 0x0108,   e_CheckValidateRuleTypePageContentTagged = 0x0109, e_CheckValidateRuleTypePageAnnotTagged = 0x010A, e_CheckValidateRuleTypePageTabOrder = 0x010B, e_CheckValidateRuleTypePageFontEncoding = 0x010C,   e_CheckValidateRuleTypePageMultimediaObjectTagged = 0x010D, e_CheckValidateRuleTypePageNoFlickering = 0x010E, e_CheckValidateRuleTypePageNoInaccessibleScript = 0x010F, e_CheckValidateRuleTypePageNoTimedResponse = 0x0110,   e_CheckValidateRuleTypePageNavigationLinkRepeat = 0x0111, e_CheckValidateRuleTypeFormFieldTagged = 0x0112, e_CheckValidateRuleTypeFormFieldAltText = 0x0113, e_CheckValidateRuleTypeTableRowsUsed = 0x0114,   e_CheckValidateRuleTypeTableThTdUsed = 0x0115, e_CheckValidateRuleTypeTableHeadersExist = 0x0116, e_CheckValidateRuleTypeTableSpanCorrect = 0x0117, e_CheckValidateRuleTypeTableSummary = 0x0118,   e_CheckValidateRuleTypeListItemsUsed = 0x0119, e_CheckValidateRuleTypeListLblLbodyUsed = 0x011A, e_CheckValidateRuleTypeFigureAltText = 0x011B, e_CheckValidateRuleTypeNoNestedAltText = 0x011C,   e_CheckValidateRuleTypeAltTextHasContent = 0x011D, e_CheckValidateRuleTypeAltTextHideAnnot = 0x011E, e_CheckValidateRuleTypeElementAltText = 0x011F, e_CheckValidateRuleTypeHeadingProperNest = 0x0120 }
	Enumeration for check validate rule type. More...

Public Member Functions
	AccessibilityCheckOptions ()
	Constructor.
	AccessibilityCheckOptions (const AccessibilityCheckOptions &other)
	Constructor, with another accessibility check options object. More...
AccessibilityCheckOptions &	operator= (const AccessibilityCheckOptions &other)
	Assign operator. More...
void	Set (UInt32Array check_rule_array, foxit::common::Range page_range)
	Set value. More...

Public Attributes
UInt32Array	check_rule_array
	The array of rules to check. Please refer to values starting from foxit::addon::accessibility::AccessibilityCheckOptions::e_CheckValidateRuleTypeDocPermission. You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.
foxit::common::Range	page_range
	The page range to be adjusted, if is empty represents all pages.

Detailed Description

This class represents accessibility check options.

Member Enumeration Documentation

CheckValidateRuleType

enum foxit::addon::accessibility::AccessibilityCheckOptions::CheckValidateRuleType

Enumeration for check validate rule type.

Values of this enumeration should be used alone.

Enumerator
e_CheckValidateRuleTypeDocPermission	Check validate rule type: doc permission.
e_CheckValidateRuleTypeDocPureImage	Check validate rule type: doc pure image.
e_CheckValidateRuleTypeDocTagged	Check validate rule type: doc tagged.
e_CheckValidateRuleTypeDocStructTreeOrder	Check validate rule type: doc struct tree order.
e_CheckValidateRuleTypeDocLanguageSpecified	Check validate rule type: doc language specified.
e_CheckValidateRuleTypeDocTitle	Check validate rule type: doc title.
e_CheckValidateRuleTypeDocOutlineForLarge	Check validate rule type: doc outline for large.
e_CheckValidateRuleTypeDocColorContrast	Check validate rule type: doc color contrast.
e_CheckValidateRuleTypePageContentTagged	Check validate rule type: page content tagged.
e_CheckValidateRuleTypePageAnnotTagged	Check validate rule type: page annot tagged.
e_CheckValidateRuleTypePageTabOrder	Check validate rule type: page tab order.
e_CheckValidateRuleTypePageFontEncoding	Check validate rule type: page font encoding.
e_CheckValidateRuleTypePageMultimediaObjectTagged	Check validate rule type: page multimedia object tagged.
e_CheckValidateRuleTypePageNoFlickering	Check validate rule type: page no flickering.
e_CheckValidateRuleTypePageNoInaccessibleScript	Check validate rule type: page no inaccessible script.
e_CheckValidateRuleTypePageNoTimedResponse	Check validate rule type: page no timed response.
e_CheckValidateRuleTypePageNavigationLinkRepeat	Check validate rule type: page navigation link repeat.
e_CheckValidateRuleTypeFormFieldTagged	Check validate rule type: form field tagged.
e_CheckValidateRuleTypeFormFieldAltText	Check validate rule type: form field alt text.
e_CheckValidateRuleTypeTableRowsUsed	Check validate rule type: table rows proper used.
e_CheckValidateRuleTypeTableThTdUsed	Check validate rule type: table TH and TD proper used.
e_CheckValidateRuleTypeTableHeadersExist	Check validate rule type: table headers exist.
e_CheckValidateRuleTypeTableSpanCorrect	Check validate rule type: table span correct.
e_CheckValidateRuleTypeTableSummary	Check validate rule type: table summary.
e_CheckValidateRuleTypeListItemsUsed	Check validate rule type: list items proper used.
e_CheckValidateRuleTypeListLblLbodyUsed	Check validate rule type: list label and LBody proper used.
e_CheckValidateRuleTypeFigureAltText	Check validate rule type: figure alt text.
e_CheckValidateRuleTypeNoNestedAltText	Check validate rule type: no nested alt text.
e_CheckValidateRuleTypeAltTextHasContent	Check validate rule type: alt text has content.
e_CheckValidateRuleTypeAltTextHideAnnot	Check validate rule type: alt text hide annot.
e_CheckValidateRuleTypeElementAltText	Check validate rule type: element alt text.
e_CheckValidateRuleTypeHeadingProperNest	Check validate rule type: heading proper nest.

Constructor & Destructor Documentation

AccessibilityCheckOptions()

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

inline

Constructor, with another accessibility check options object.

Parameters

[in]

other

Another accessibility check options object.

Member Function Documentation

operator=()

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

inline

Assign operator.

Parameters

[in]

other

Another accessibility check options object, whose value would be assigned to current object.

Returns

Reference to current object itself.

Set()

void foxit::addon::accessibility::AccessibilityCheckOptions::Set ( UInt32Array  check_rule_array, foxit::common::Range  page_range  )

inline

Set value.

Parameters

[in]	check_rule_array	The array of rules to check. Please refer to values starting from foxit::addon::accessibility::AccessibilityCheckOptions::e_CheckValidateRuleTypeDocPermission. You can provide a single rule or multiple rules in the array, and the array should contain at least one valid rule value.
[in]	page_range	The page range to be adjusted, if is empty represents all pages.

Returns

None.