Foxit PDF SDK
foxit::addon::accessibility Namespace Reference

Accessibility namespace. More...

Classes

class  AccessibilityChecker
 
class  AccessibilityCheckOptions
 
class  AccessibilityCheckResultDetailData
 
class  AccessibilityCheckResultDetailDataArray
 
class  AccessibilityCheckResultItemData
 
class  AccessibilityCheckResultItemDataArray
 
class  AccessibilityCheckResultsCallback
 
class  AccessibilityCheckResultSubItemData
 
class  AccessibilityCheckResultSubItemDataArray
 
class  AccessibilityDictionaryTreeItem
 
class  AccessibilityDictionaryTreeItemData
 
class  AccessibilityDictionaryTreeItemDataArray
 
class  AccessibilityFindResult
 
class  AccessibilityFixer
 
class  AccessibilityLineInfo
 
class  AccessibilityLineInfoArray
 
class  AccessibilityNavigator
 
class  AccessibilityProviderCallback
 
class  AccessibilityRectInfo
 
class  AccessibilityRectInfoArray
 
class  AccessibilityTagTreeItem
 
class  AccessibilityTextInfo
 
class  AccessibilityTextInfoArray
 
class  AlternateTextFigureData
 Data structure for alternate text information of a figure. More...
 
class  AutoTagProviderCallback
 
class  ContentTreeItem
 
class  ContentTreeItemData
 
class  ReadingOrder
 
class  ReadingOrderOptions
 
class  SelectItemInfo
 
class  SelectItemInfoArray
 
class  TableCellAttribute
 
class  TableCellAttributeArray
 
class  TaggedPDF
 
class  TaggedPDFCallback
 
class  TagProperty
 
class  TagTreeEditor
 
class  TagTreeItemArray
 
class  TagTreeItemData
 
class  TagTreeItemDataArray
 
class  TagTreeMenuInputData
 
class  TagTreeMenuItemData
 
class  TagTreeMenuItemDataArray
 
class  TreeItem
 
class  TreeItemArray
 
class  TreeItemInfo
 
class  TreeItemInfoArray
 

Enumerations

enum  CheckState {
  e_CheckStateNone = 0, e_CheckStatePassed = 1, e_CheckStateFailed = 2, e_CheckStateHumanCheck = 3,
  e_CheckStateSkipped = 4, e_CheckStateHumanPassed = 5, e_CheckStateHumanFailed = 6, e_CheckStateLast = 7
}
 Enumeration for check state. More...
 
enum  ContentType {
  e_ContentTypeUnknown = 0, e_ContentTypeDoc = 1, e_ContentTypePage = 2, e_ContentTypeEmptyObject = 3,
  e_ContentTypeTextGroup = 4, e_ContentTypeTextObject = 5, e_ContentTypePathObject = 6, e_ContentTypeShadingObject = 7,
  e_ContentTypeImageObject = 8, e_ContentTypeAnnotGroup = 9, e_ContentTypeAnnot = 10, e_ContentTypeContainer = 11,
  e_ContentTypeFormXObject = 12
}
 Enumeration for content type. More...
 
enum  RuleType {
  e_RuleTypeDocPermission = 0, e_RuleTypeDocImageOnly = 1, e_RuleTypeDocTagged = 2, e_RuleTypeDocStructreeOrder = 3,
  e_RuleTypeDocLang = 4, e_RuleTypeDocTitle = 5, e_RuleTypeDocBookmark = 6, e_RuleTypeDocColorcontrast = 7,
  e_RuleTypePageContentTagged = 8, e_RuleTypePageAnnotTagged = 9, e_RuleTypePageTabOrder = 10, e_RuleTypePageFontEncoding = 11,
  e_RuleTypePageMultiMediaTagged = 12, e_RuleTypePageFlickering = 13, e_RuleTypePageScript = 14, e_RuleTypePageResponses = 15,
  e_RuleTypePageLink = 16, e_RuleTypeFormFieldTagged = 17, e_RuleTypeFormFieldAltText = 18, e_RuleTypeTableRows = 19,
  e_RuleTypeTableThAndTd = 20, e_RuleTypeTableHeaders = 21, e_RuleTypeTableRegularity = 22, e_RuleTypeTableSummary = 23,
  e_RuleTypeListItems = 24, e_RuleTypeListLblAndLbody = 25, e_RuleTypeAlternateTextFigures = 26, e_RuleTypeAlternateTextNested = 27,
  e_RuleTypeAlternateTextContent = 28, e_RuleTypeAlternateTextAnnot = 29, e_RuleTypeAlternateTextOther = 30, e_RuleTypeHeading = 31
}
 Enumeration for rule type. More...
 

Detailed Description

Accessibility namespace.

Enumeration Type Documentation

◆ CheckState

Enumeration for check state.

Values of this enumeration should be used alone.

Enumerator
e_CheckStateNone 

Check state : none.

e_CheckStatePassed 

Check state : passed.

e_CheckStateFailed 

Check state : failed.

e_CheckStateHumanCheck 

Check state : human check.

e_CheckStateSkipped 

Check state : skipped.

e_CheckStateHumanPassed 

Check state : human passed.

e_CheckStateHumanFailed 

Check state : human failed.

e_CheckStateLast 

Check state : last.

◆ ContentType

Enumeration for content type.

This enumeration is used to specify the type of content in the reading order and content tree. Values of this enumeration should be used alone.

Enumerator
e_ContentTypeUnknown 

Unknown content.

e_ContentTypeDoc 

Doc item type.

e_ContentTypePage 

Page item type.

e_ContentTypeEmptyObject 

Empty object item type.

e_ContentTypeTextGroup 

Text group item type.

e_ContentTypeTextObject 

Text object item type.

e_ContentTypePathObject 

Path object item type.

e_ContentTypeShadingObject 

Shading object item type.

e_ContentTypeImageObject 

Image object item type.

e_ContentTypeAnnotGroup 

Annotation group item type.

e_ContentTypeAnnot 

Annotation item type.

e_ContentTypeContainer 

Container item type.

e_ContentTypeFormXObject 

Form XObject item type.

◆ RuleType

Enumeration for rule type.

Values of this enumeration should be used alone.

Enumerator
e_RuleTypeDocPermission 

Rule: Document permission.

e_RuleTypeDocImageOnly 

Rule: Document is pure image.

e_RuleTypeDocTagged 

Rule: Document is tagged.

e_RuleTypeDocStructreeOrder 

Rule: Document structure tree order.

e_RuleTypeDocLang 

Rule: Document language specified.

e_RuleTypeDocTitle 

Rule: Document title.

e_RuleTypeDocBookmark 

Rule: Document bookmark.

e_RuleTypeDocColorcontrast 

Rule: Document color contrast.

e_RuleTypePageContentTagged 

Rule: Page content is tagged.

e_RuleTypePageAnnotTagged 

Rule: Page annotation is tagged.

e_RuleTypePageTabOrder 

Rule: Page tab order.

e_RuleTypePageFontEncoding 

Rule: Page font encoding.

e_RuleTypePageMultiMediaTagged 

Rule: Page multimedia object is tagged.

e_RuleTypePageFlickering 

Rule: Page flickering.

e_RuleTypePageScript 

Rule: Page script.

e_RuleTypePageResponses 

Rule: Page responses.

e_RuleTypePageLink 

Rule: Page link.

e_RuleTypeFormFieldTagged 

Rule: Form field is tagged.

e_RuleTypeFormFieldAltText 

Rule: Form field alternate text.

e_RuleTypeTableRows 

Rule: Table rows proper used.

e_RuleTypeTableThAndTd 

Rule: Table TH and TD proper used.

e_RuleTypeTableHeaders 

Rule: Table headers exist.

e_RuleTypeTableRegularity 

Rule: Table regularity (span correct).

e_RuleTypeTableSummary 

Rule: Table summary.

e_RuleTypeListItems 

Rule: List items proper used.

e_RuleTypeListLblAndLbody 

Rule: List label and LBody proper used.

e_RuleTypeAlternateTextFigures 

Rule: Alternate text for figures.

e_RuleTypeAlternateTextNested 

Rule: Alternate text not nested.

e_RuleTypeAlternateTextContent 

Rule: Alternate text has content.

e_RuleTypeAlternateTextAnnot 

Rule: Alternate text hide annotation.

e_RuleTypeAlternateTextOther 

Rule: Alternate text for other elements.

e_RuleTypeHeading 

Rule: Heading proper nest.