Foxit PDF SDK
Public Types | Public Member Functions | List of all members
foxit.addon.accessibility.AccessibilityProviderCallback Class Reference

Inherits SystemIDisposable.

Public Types

enum  DrawRectType {
  DrawRectType.e_DrawRectTypeContent = 0, DrawRectType.e_DrawRectTypeTableCell = 1, DrawRectType.e_DrawRectTypeTableFigure = 2, DrawRectType.e_DrawRectTypeOrderRect = 3,
  DrawRectType.e_DrawRectTypeText = 4, DrawRectType.e_DrawRectTypeTableLabel = 5, DrawRectType.e_DrawRectTypeLine = 6, DrawRectType.e_DrawRectTypeLabel = 7,
  DrawRectType.e_DrawRectTypeTableCellsType = 8, DrawRectType.e_DrawRectTypeTableCellsBorder = 9, DrawRectType.e_DrawRectTypeTableCellsSelectedBorder = 10, DrawRectType.e_DrawRectTypeTableCellsHeaderBackground = 11,
  DrawRectType.e_DrawRectTypeTableCellsDataBackground = 12, DrawRectType.e_DrawRectTypeTableCellsHeaderBackgroundMultispan = 13, DrawRectType.e_DrawRectTypeTableCellsDataBackgroundMultispan = 14, DrawRectType.e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader = 15,
  DrawRectType.e_DrawRectTypeTableCellsDataBackgroundMissingHeader = 16
}
 Enumeration for draw rect type. More...
 

Public Member Functions

virtual void DrawLine (PDFDoc pdf_doc, int page_index, AccessibilityProviderCallback.DrawRectType type, AccessibilityLineInfoArray line_info_array)
 A callback function used to draw lines for accessibility visualization. More...
 
virtual void DrawRect (PDFDoc pdf_doc, int page_index, AccessibilityProviderCallback.DrawRectType type, AccessibilityRectInfoArray rect_info_array)
 A callback function used to draw rectangles for accessibility visualization. More...
 
virtual void DrawText (PDFDoc pdf_doc, int page_index, AccessibilityProviderCallback.DrawRectType type, AccessibilityTextInfoArray text_info_array)
 A callback function used to draw text for accessibility visualization. More...
 
virtual bool GenerateContent (PDFDoc pdf_doc, int page_index)
 A callback function used to generate content for a specified page. More...
 
virtual string GetDocumentFileName (PDFDoc pdf_doc)
 A callback function used to get the document file name. More...
 
virtual string GetTextStringByStringID (string string_id)
 A callback function used to get text string by string ID. More...
 
virtual void OnContentChanged (PDFDoc pdf_doc, int page_index, bool is_notify_self)
 A callback function used to notify that content has changed on a specified page. More...
 
virtual void Release ()
 A callback function used to release current callback object itself. More...
 

Detailed Description

This class represents a render provider for accessibility, used to generate content and draw visual elements.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class. The render provider is shared between the accessibility classes and ReadingOrderEditor, providing rendering capabilities for accessibility visual feedback.

Member Enumeration Documentation

◆ DrawRectType

enum foxit.addon.accessibility.AccessibilityProviderCallback.DrawRectType
strong

Enumeration for draw rect type.

This enumeration is used by AccessibilityProviderCallback to specify the type of drawing rectangle. Values of this enumeration should be used alone.

Enumerator
e_DrawRectTypeContent 

Draw rect type : content.

e_DrawRectTypeTableCell 

Draw rect type : table cell.

e_DrawRectTypeTableFigure 

Draw rect type : table figure.

e_DrawRectTypeOrderRect 

Draw rect type : order rect.

e_DrawRectTypeText 

Draw rect type : text.

e_DrawRectTypeTableLabel 

Draw rect type : table label.

e_DrawRectTypeLine 

Draw rect type : line.

e_DrawRectTypeLabel 

Draw rect type : label.

e_DrawRectTypeTableCellsType 

Draw rect type : table cells type.

e_DrawRectTypeTableCellsBorder 

Draw rect type : table cells border.

e_DrawRectTypeTableCellsSelectedBorder 

Draw rect type : table cells selected border.

e_DrawRectTypeTableCellsHeaderBackground 

Draw rect type : table cells header background.

e_DrawRectTypeTableCellsDataBackground 

Draw rect type : table cells data background.

e_DrawRectTypeTableCellsHeaderBackgroundMultispan 

Draw rect type : table cells header background multispan.

e_DrawRectTypeTableCellsDataBackgroundMultispan 

Draw rect type : table cells data background multispan.

e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader 

Draw rect type : table cells header background missing header.

e_DrawRectTypeTableCellsDataBackgroundMissingHeader 

Draw rect type : table cells data background missing header.

Member Function Documentation

◆ DrawLine()

void foxit.addon.accessibility.AccessibilityProviderCallback.DrawLine ( PDFDoc  pdf_doc,
int  page_index,
AccessibilityProviderCallback.DrawRectType  type,
AccessibilityLineInfoArray  line_info_array 
)
inlinevirtual

A callback function used to draw lines for accessibility visualization.

Parameters
[in]pdf_docThe PDF document object.
[in]page_indexThe page index.
[in]typeThe draw rect type. Please refer to values starting from foxit.addon.accessibility.AccessibilityProviderCallback.DrawRectType.e_DrawRectTypeContent and this should be one of these values..
[in]line_info_arrayThe array of accessibility line info objects.
Returns
None.

◆ DrawRect()

void foxit.addon.accessibility.AccessibilityProviderCallback.DrawRect ( PDFDoc  pdf_doc,
int  page_index,
AccessibilityProviderCallback.DrawRectType  type,
AccessibilityRectInfoArray  rect_info_array 
)
inlinevirtual

A callback function used to draw rectangles for accessibility visualization.

Parameters
[in]pdf_docThe PDF document object.
[in]page_indexThe page index.
[in]typeThe draw rect type. Please refer to values starting from foxit.addon.accessibility.AccessibilityProviderCallback.DrawRectType.e_DrawRectTypeContent and this should be one of these values..
[in]rect_info_arrayThe array of accessibility rect info objects.
Returns
None.

◆ DrawText()

void foxit.addon.accessibility.AccessibilityProviderCallback.DrawText ( PDFDoc  pdf_doc,
int  page_index,
AccessibilityProviderCallback.DrawRectType  type,
AccessibilityTextInfoArray  text_info_array 
)
inlinevirtual

A callback function used to draw text for accessibility visualization.

Parameters
[in]pdf_docThe PDF document object.
[in]page_indexThe page index.
[in]typeThe draw rect type. Please refer to values starting from foxit.addon.accessibility.AccessibilityProviderCallback.DrawRectType.e_DrawRectTypeContent and this should be one of these values..
[in]text_info_arrayThe array of accessibility text info objects.
Returns
None.

◆ GenerateContent()

bool foxit.addon.accessibility.AccessibilityProviderCallback.GenerateContent ( PDFDoc  pdf_doc,
int  page_index 
)
inlinevirtual

A callback function used to generate content for a specified page.

Parameters
[in]pdf_docThe PDF document object.
[in]page_indexThe page index.
Returns
true means content generated successfully, while false means not.

◆ GetDocumentFileName()

string foxit.addon.accessibility.AccessibilityProviderCallback.GetDocumentFileName ( PDFDoc  pdf_doc)
inlinevirtual

A callback function used to get the document file name.

Parameters
[in]pdf_docThe PDF document object.
Returns
The document file name.

◆ GetTextStringByStringID()

string foxit.addon.accessibility.AccessibilityProviderCallback.GetTextStringByStringID ( string  string_id)
inlinevirtual

A callback function used to get text string by string ID.

Parameters
[in]string_idThe string ID.
Returns
The text string.

◆ OnContentChanged()

void foxit.addon.accessibility.AccessibilityProviderCallback.OnContentChanged ( PDFDoc  pdf_doc,
int  page_index,
bool  is_notify_self 
)
inlinevirtual

A callback function used to notify that content has changed on a specified page.

Parameters
[in]pdf_docThe PDF document object.
[in]page_indexThe page index.
[in]is_notify_selfWhether to notify self.
Returns
None.

◆ Release()

void foxit.addon.accessibility.AccessibilityProviderCallback.Release ( )
inlinevirtual

A callback function used to release current callback object itself.

Returns
None.