foxit::addon::accessibility::AutoTagProviderCallback Class Reference

Public Types
enum	AutoTagResultDataType {   e_AutoTagResultDataTypeReduceConfidence = 0, e_AutoTagResultDataTypeTagreportPrepage = 1, e_AutoTagResultDataTypeTagreportNextpage = 2, e_AutoTagResultDataTypePage = 3,   e_AutoTagResultDataTypeRegions = 4, e_AutoTagResultDataTypeArtifacts = 5, e_AutoTagResultDataTypeParagraphs = 6, e_AutoTagResultDataTypeListItem = 7,   e_AutoTagResultDataTypeFigures = 8, e_AutoTagResultDataTypeTables = 9, e_AutoTagResultDataTypeTableRow = 10, e_AutoTagResultDataTypeTableHeader = 11,   e_AutoTagResultDataTypeToc = 12, e_AutoTagResultDataTypeHighConfidence = 13, e_AutoTagResultDataTypeMediumhighConfidence = 14, e_AutoTagResultDataTypeMediumConfidence = 15,   e_AutoTagResultDataTypeMediumlowConfidence = 16, e_AutoTagResultDataTypeLowConfidence = 17, e_AutoTagResultDataTypeCheckCategory = 18, e_AutoTagResultDataTypeFixCategory = 19,   e_AutoTagResultDataTypeHintRegion = 20, e_AutoTagResultDataTypeHintArtifacts = 21, e_AutoTagResultDataTypeHintParagraph = 22, e_AutoTagResultDataTypeHintList = 23,   e_AutoTagResultDataTypeHintFigure = 24, e_AutoTagResultDataTypeHintTables = 25, e_AutoTagResultDataTypeHintTableRow = 26, e_AutoTagResultDataTypeHintTableHeader = 27,   e_AutoTagResultDataTypeHintToc = 28, e_AutoTagResultDataTypeHintRepair = 29, e_AutoTagResultDataTypeTouchupReadingOrder = 30, e_AutoTagResultDataTypeAlttext = 31,   e_AutoTagResultDataTypeHintAlttext = 32, e_AutoTagResultDataTypeCheckerTable5 = 33, e_AutoTagResultDataTypeIntroduction = 34, e_AutoTagResultDataTypeSumReduceConfidence = 35,   e_AutoTagResultDataTypeRibbonCategory = 36, e_AutoTagResultDataTypeSumAlttextFigure = 37, e_AutoTagResultDataTypeTagrepIntroduction = 38, e_AutoTagResultDataTypeMissFigure = 39,   e_AutoTagResultDataTypeTagreportFilename = 40, e_AutoTagResultDataTypeBacktotop = 41 }
	Enumeration for accessibility auto tag result data type. More...

Public Member Functions
virtual foxit::WString	GetReportText (AutoTagResultDataType type)=0
	Get the display text for an auto tag result data type. More...

Detailed Description

This class represents an auto tag results provider for accessibility.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class.

Member Enumeration Documentation

AutoTagResultDataType

enum foxit::addon::accessibility::AutoTagProviderCallback::AutoTagResultDataType

Enumeration for accessibility auto tag result data type.

Values of this enumeration should be used alone.

Enumerator
e_AutoTagResultDataTypeReduceConfidence	Auto tag result data type: reduce confidence.
e_AutoTagResultDataTypeTagreportPrepage	Auto tag result data type: tagreport prepage.
e_AutoTagResultDataTypeTagreportNextpage	Auto tag result data type: tagreport nextpage.
e_AutoTagResultDataTypePage	Auto tag result data type: page.
e_AutoTagResultDataTypeRegions	Auto tag result data type: regions.
e_AutoTagResultDataTypeArtifacts	Auto tag result data type: artifacts.
e_AutoTagResultDataTypeParagraphs	Auto tag result data type: paragraphs.
e_AutoTagResultDataTypeListItem	Auto tag result data type: listitem.
e_AutoTagResultDataTypeFigures	Auto tag result data type: figures.
e_AutoTagResultDataTypeTables	Auto tag result data type: tables.
e_AutoTagResultDataTypeTableRow	Auto tag result data type: table row.
e_AutoTagResultDataTypeTableHeader	Auto tag result data type: table header.
e_AutoTagResultDataTypeToc	Auto tag result data type: toc.
e_AutoTagResultDataTypeHighConfidence	Auto tag result data type: high confidence.
e_AutoTagResultDataTypeMediumhighConfidence	Auto tag result data type: mediumhigh confidence.
e_AutoTagResultDataTypeMediumConfidence	Auto tag result data type: medium confidence.
e_AutoTagResultDataTypeMediumlowConfidence	Auto tag result data type: mediumlow confidence.
e_AutoTagResultDataTypeLowConfidence	Auto tag result data type: low confidence.
e_AutoTagResultDataTypeCheckCategory	Auto tag result data type: check category.
e_AutoTagResultDataTypeFixCategory	Auto tag result data type: fix category.
e_AutoTagResultDataTypeHintRegion	Auto tag result data type: hint region.
e_AutoTagResultDataTypeHintArtifacts	Auto tag result data type: hint artifacts.
e_AutoTagResultDataTypeHintParagraph	Auto tag result data type: hint paragraph.
e_AutoTagResultDataTypeHintList	Auto tag result data type: hint list.
e_AutoTagResultDataTypeHintFigure	Auto tag result data type: hint figure.
e_AutoTagResultDataTypeHintTables	Auto tag result data type: hint tables.
e_AutoTagResultDataTypeHintTableRow	Auto tag result data type: hint tablerow.
e_AutoTagResultDataTypeHintTableHeader	Auto tag result data type: hint tableheader.
e_AutoTagResultDataTypeHintToc	Auto tag result data type: hint toc.
e_AutoTagResultDataTypeHintRepair	Auto tag result data type: hint repair.
e_AutoTagResultDataTypeTouchupReadingOrder	Auto tag result data type: touchup reading order.
e_AutoTagResultDataTypeAlttext	Auto tag result data type: alttext.
e_AutoTagResultDataTypeHintAlttext	Auto tag result data type: hint alttext.
e_AutoTagResultDataTypeCheckerTable5	Auto tag result data type: checker table 5.
e_AutoTagResultDataTypeIntroduction	Auto tag result data type: introduction.
e_AutoTagResultDataTypeSumReduceConfidence	Auto tag result data type: sum reduce confidence.
e_AutoTagResultDataTypeRibbonCategory	Auto tag result data type: ribbon category.
e_AutoTagResultDataTypeSumAlttextFigure	Auto tag result data type: sum alttext figure.
e_AutoTagResultDataTypeTagrepIntroduction	Auto tag result data type: tagrep introduction.
e_AutoTagResultDataTypeMissFigure	Auto tag result data type: miss figure.
e_AutoTagResultDataTypeTagreportFilename	Auto tag result data type: tagreport filename.
e_AutoTagResultDataTypeBacktotop	Auto tag result data type: back to top.

Member Function Documentation

GetReportText()

virtual foxit::WString foxit::addon::accessibility::AutoTagProviderCallback::GetReportText ( AutoTagResultDataType  type )

pure virtual

Get the display text for an auto tag result data type.

This callback is invoked by the SDK while it generates the "Add Tags" report during auto tagging. For each result data type (see AutoTagResultDataType ), the SDK requests the corresponding (typically localized) display string from the application, so the application controls all user-visible wording in the report.

Most types map to a plain label (for example "Figures", "Artifacts", "Table Summary"). A few types expect the returned string to contain a printf-style placeholder that the SDK substitutes at runtime; the implementation must keep the placeholder and its order intact:

• %d page number (1-based): e_AutoTagResultDataTypePage ("Page %d"), e_AutoTagResultDataTypeMissFigure ("Figure missing AltText on page %d.");
• %d count: e_AutoTagResultDataTypeSumReduceConfidence ("%d reduced confidence pages"), e_AutoTagResultDataTypeSumAlttextFigure ("%d figures missing AltText");
• %ls category name: e_AutoTagResultDataTypeCheckCategory ("%ls to check."), e_AutoTagResultDataTypeFixCategory ("How to Fix %ls Tagging.");
• %ls file name: e_AutoTagResultDataTypeTagreportFilename ("Add Tags Report for %ls").

Return an empty string for an unknown or unhandled type.

Parameters

[in]

type

One value of the AutoTagResultDataType enumeration, that the SDK is requesting text for.

Returns

The display text for type (may contain a placeholder as noted above), or an empty string if the type is not handled.