Foxit PDF SDK
foxit::addon::tablegenerator::TableGeneratorCallback Class Referenceabstract

Public Member Functions

virtual foxit::pdf::PageBasicInfo GetNewPageBasicInfo (int page_index, float rest_table_height, float table_width)=0
 A callback function to get new page basic information to be generated to a new page. More...
 
virtual float GetTableTopMarginToPage (int page_index)=0
 A callback function to get the top margin of the table to be generated to a new page. More...
 
virtual void Release ()=0
 A callback function used to release current callback object itself. More...
 

Detailed Description

This class represents a callback object for generating table. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

Member Function Documentation

◆ GetNewPageBasicInfo()

virtual foxit::pdf::PageBasicInfo foxit::addon::tablegenerator::TableGeneratorCallback::GetNewPageBasicInfo ( int  page_index,
float  rest_table_height,
float  table_width 
)
pure virtual

A callback function to get new page basic information to be generated to a new page.

This callback function is only used for TableGenerator::InsertTablePagesToDocument. It will be triggered if the page width or page height is less than or equal to zero. Users must ensure that the text size is greater than zero in pdf::RichTextStyle if the content of cell is text.

Parameters
[in]page_indexThe page index. It would start from 0.
[in]rest_table_heightThe rest table height(unit is 1/72 inch).
[in]table_widthThe table width(unit is 1/72 inch).
Returns
The basic page information.(The rotation is not supported currently).

◆ GetTableTopMarginToPage()

virtual float foxit::addon::tablegenerator::TableGeneratorCallback::GetTableTopMarginToPage ( int  page_index)
pure virtual

A callback function to get the top margin of the table to be generated to a new page.

Parameters
[in]page_indexThe page index. It would start from 0.
Returns
The table top margin to page.

◆ Release()

virtual void foxit::addon::tablegenerator::TableGeneratorCallback::Release ( )
pure virtual

A callback function used to release current callback object itself.

Returns
None.