Foxit PDF SDK
foxit::addon::accessibility::TaggedPDFCallback Class Referenceabstract

Public Types

enum  ReportCategory {
  e_ReportCategoryRegion = 0, e_ReportCategoryArtifact = 1, e_ReportCategoryParagraph = 2, e_ReportCategoryListItem = 3,
  e_ReportCategoryFigure = 4, e_ReportCategoryTable = 5, e_ReportCategoryTableRow = 6, e_ReportCategoryTableHeader = 7,
  e_ReportCategoryTocItem = 8
}
 Enumeration for report category type used for tagged PDF. More...
 
enum  ReportConfidence {
  e_ReportConfidenceHigh = 0, e_ReportConfidenceMediumHigh = 1, e_ReportConfidenceMedium = 2, e_ReportConfidenceMediumLow = 3,
  e_ReportConfidenceLow = 4
}
 Enumeration for report confidence used for tag PDF document. More...
 

Public Member Functions

virtual void Release ()=0
 A callback function used to release current callback object itself. More...
 
virtual void Report (ReportCategory category, ReportConfidence confidence, int page_index, const RectF &rect)=0
 A callback function used to get the tagged PDF document result information, triggered when the document will be tagged. More...
 

Detailed Description

This class represents a callback object used to tag PDF document. All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class. User can also re-write the virtual functions in this class in custom way.

Member Enumeration Documentation

◆ ReportCategory

Enumeration for report category type used for tagged PDF.

Values of this enumeration should be used alone.

Enumerator
e_ReportCategoryRegion 

Report category type: region.

e_ReportCategoryArtifact 

Report category type: artifact.

e_ReportCategoryParagraph 

Report category type: paragraph.

e_ReportCategoryListItem 

Report category type: list item.

e_ReportCategoryFigure 

Report category type: figure.

e_ReportCategoryTable 

Report category type: table.

e_ReportCategoryTableRow 

Report category type: table row.

e_ReportCategoryTableHeader 

Report category type: table header.

e_ReportCategoryTocItem 

Report category type: toc item.

◆ ReportConfidence

Enumeration for report confidence used for tag PDF document.

Values of this enumeration should be used alone.

Enumerator
e_ReportConfidenceHigh 

Report confidence: high.

e_ReportConfidenceMediumHigh 

Report confidence: medium high.

e_ReportConfidenceMedium 

Report confidence: medium.

e_ReportConfidenceMediumLow 

Report confidence: medium low.

e_ReportConfidenceLow 

Report confidence: low.

Member Function Documentation

◆ Release()

virtual void foxit::addon::accessibility::TaggedPDFCallback::Release ( )
pure virtual

A callback function used to release current callback object itself.

Returns
None.

◆ Report()

virtual void foxit::addon::accessibility::TaggedPDFCallback::Report ( ReportCategory  category,
ReportConfidence  confidence,
int  page_index,
const RectF rect 
)
pure virtual

A callback function used to get the tagged PDF document result information, triggered when the document will be tagged.

This function is very useful for user to get the tagged PDF document result information.

Parameters
[in]categoryThe report category for tagged PDF. Please refer to values starting from TaggedPDFCallback::e_ReportCategoryRegion and this would be one of these values.
[in]confidenceThe report confidence for tagged PDF. Please refer to values starting from TaggedPDFCallback::e_ReportConfidenceHigh and this would be one of these values.
[in]page_indexThe page index of current report item belongs to.
[in]rectThe rectangle of current report item.
Returns
None.