#include <pdfxml.h>

Public Member Functions
	wxPdfTable (wxPdfDocument *document)
	Constructor.
virtual	~wxPdfTable ()
	Destructor.
void	SetMinRowHeight (int row, double height)
	Set minimum required row height.
void	SetMaxRowHeight (int row, double height)
	Set maximum allowed row height.
void	SetColumnWidth (int col, double width)
	Set width of column.
void	SetCellDimensions (double maxWidth)
	Calculate cell dimensions respecting a maximum allowed width.
void	InsertCell (wxPdfTableCell *c)
	Insert a cell into the cell array.
double	WriteOnPage (bool writeHeader, double x, double y)
	Write table header on current page.
double	WriteRowsOnPage (unsigned firstRow, unsigned lastRow, double x, double y, bool writeHeader)
	Write range of rows on current page.
unsigned int	AddPage (wxArrayInt::const_iterator iter, wxArrayInt::const_iterator endIter)
	Add a page and return last table row on page.
double	WriteTable (bool writeHeader, const wxArrayInt &lastRowsOnPage, double x, double y)
	Write the whole table.
double	GetRowHeight (int row)
	Get height of row.
void	Write ()
	Write table to document.
double	WriteRows (unsigned int firstRow, unsigned int lastRow, double x, double y, bool isHeaderRow)
	Write range of rows.
void	SetPad (double pad)
	Set cell padding.
double	GetPad ()
	Get cell padding.
void	SetBorder (bool border)
	Set border flag.
void	SetBorderWidth (double borderWidth)
	Set border size.
void	SetBorderColour (wxPdfColour borderColour)
	Set border colour.
bool	HasBorder ()
	Check whether border should be drawn.
double	GetTotalWidth ()
	Get total width of table.
double	GetHeadHeight ()
	Get height of table head.
double	GetBodyHeight ()
	Get height of table body.
double	GetTotalHeight ()
	Get total height of table.
void	SetHeadRowFirst (unsigned int row)
	Set index of first header row.
void	SetHeadRowLast (unsigned int row)
	Set index of last header row.
void	SetBodyRowFirst (unsigned int row)
	Set index of first body row.
void	SetBodyRowLast (unsigned int row)
	Set index of last body row.

Detailed Description

Class representing tables within a cell. (For internal use only)

Constructor & Destructor Documentation

◆ wxPdfTable()

wxPdfTable::wxPdfTable ( wxPdfDocument * document )

Constructor.

Parameters

document Pointer to the associated PDF document

◆ ~wxPdfTable()

virtual wxPdfTable::~wxPdfTable ( )

virtual

Destructor.

Member Function Documentation

◆ AddPage()

unsigned int wxPdfTable::AddPage	(	wxArrayInt::const_iterator	iter,
		wxArrayInt::const_iterator	endIter )

Add a page and return last table row on page.

Parameters

iter	Iterator to current row index
endIter	Iterator to end of row index list

Returns: Index of last row on page

◆ GetBodyHeight()

double wxPdfTable::GetBodyHeight ( )

inline

Get height of table body.

Returns: Body height

◆ GetHeadHeight()

double wxPdfTable::GetHeadHeight ( )

inline

Get height of table head.

Returns: Header height

◆ GetPad()

double wxPdfTable::GetPad ( )

inline

Get cell padding.

Returns: Padding

◆ GetRowHeight()

double wxPdfTable::GetRowHeight ( int row )

inline

Get height of row.

Parameters

row Row index

Returns: Row height

◆ GetTotalHeight()

double wxPdfTable::GetTotalHeight ( )

inline

Get total height of table.

Returns: Total height

◆ GetTotalWidth()

double wxPdfTable::GetTotalWidth ( )

inline

Get total width of table.

Returns: Total width

◆ HasBorder()

bool wxPdfTable::HasBorder ( )

inline

Check whether border should be drawn.

Returns: true if border should be drawn, false otherwise

◆ InsertCell()

void wxPdfTable::InsertCell ( wxPdfTableCell * c )

Insert a cell into the cell array.

Parameters

c	Pointer to the table cell to insert

◆ SetBodyRowFirst()

void wxPdfTable::SetBodyRowFirst ( unsigned int row )

inline

Set index of first body row.

Parameters

row Row index

◆ SetBodyRowLast()

void wxPdfTable::SetBodyRowLast ( unsigned int row )

inline

Set index of last body row.

Parameters

row Row index

◆ SetBorder()

void wxPdfTable::SetBorder ( bool border )

inline

Set border flag.

Parameters

border Border flag

◆ SetBorderColour()

void wxPdfTable::SetBorderColour ( wxPdfColour borderColour )

inline

Set border colour.

Parameters

borderColour Border colour

◆ SetBorderWidth()

void wxPdfTable::SetBorderWidth ( double borderWidth )

inline

Set border size.

Parameters

borderWidth Border width

◆ SetCellDimensions()

void wxPdfTable::SetCellDimensions ( double maxWidth )

Calculate cell dimensions respecting a maximum allowed width.

Parameters

maxWidth Maximum allowed width

◆ SetColumnWidth()

void wxPdfTable::SetColumnWidth	(	int	col,
		double	width )

Set width of column.

Parameters

col	Column index
width	Column width

◆ SetHeadRowFirst()

void wxPdfTable::SetHeadRowFirst ( unsigned int row )

inline

Set index of first header row.

Parameters

row Row index

◆ SetHeadRowLast()

void wxPdfTable::SetHeadRowLast ( unsigned int row )

inline

Set index of last header row.

Parameters

row Row index

◆ SetMaxRowHeight()

void wxPdfTable::SetMaxRowHeight	(	int	row,
		double	height )

inline

Set maximum allowed row height.

Parameters

row	Row index
height	Maximum height

◆ SetMinRowHeight()

void wxPdfTable::SetMinRowHeight	(	int	row,
		double	height )

inline

Set minimum required row height.

Parameters

row	Row index
height	Minimum height

◆ SetPad()

void wxPdfTable::SetPad ( double pad )

inline

Set cell padding.

Parameters

pad Padding

◆ Write()

void wxPdfTable::Write ( )

Write table to document.

◆ WriteOnPage()

double wxPdfTable::WriteOnPage	(	bool	writeHeader,
		double	x,
		double	y )

Write table header on current page.

Parameters

writeHeader	Flag whether to write the header
x	Abscissa of the top left corner
y	Ordinate of the top left corner

Returns: Vertical position after writing

◆ WriteRows()

double wxPdfTable::WriteRows	(	unsigned int	firstRow,
		unsigned int	lastRow,
		double	x,
		double	y,
		bool	isHeaderRow )

Write range of rows.

Parameters

firstRow	Index of first row
lastRow	Index of last row
x	Abscissa of the top left corner
y	Ordinate of the top left corner
isHeaderRow	Flag whether the rows are header rows

Returns: Vertical position after writing

◆ WriteRowsOnPage()

double wxPdfTable::WriteRowsOnPage	(	unsigned	firstRow,
		unsigned	lastRow,
		double	x,
		double	y,
		bool	writeHeader )

Write range of rows on current page.

Parameters

firstRow	Index of first row
lastRow	Index of last row
x	Abscissa of the top left corner
y	Ordinate of the top left corner
writeHeader	Flag whether to write the header

Returns: Vertical position after writing

◆ WriteTable()

double wxPdfTable::WriteTable	(	bool	writeHeader,
		const wxArrayInt &	lastRowsOnPage,
		double	x,
		double	y )

Write the whole table.

Parameters

writeHeader	Flag whether to write the header
lastRowsOnPage	List of last rows on each page
x	Abscissa of the top left corner
y	Ordinate of the top left corner

Returns: Vertical position after writing

The documentation for this class was generated from the following file:

E:/github/wxpdfdoc-current/include/wx/pdfxml.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ wxPdfTable()

◆ ~wxPdfTable()

Member Function Documentation

◆ AddPage()

◆ GetBodyHeight()

◆ GetHeadHeight()

◆ GetPad()

◆ GetRowHeight()

◆ GetTotalHeight()

◆ GetTotalWidth()

◆ HasBorder()

◆ InsertCell()

◆ SetBodyRowFirst()

◆ SetBodyRowLast()

◆ SetBorder()

◆ SetBorderColour()

◆ SetBorderWidth()

◆ SetCellDimensions()

◆ SetColumnWidth()

◆ SetHeadRowFirst()

◆ SetHeadRowLast()

◆ SetMaxRowHeight()

◆ SetMinRowHeight()

◆ SetPad()

◆ Write()

◆ WriteOnPage()

◆ WriteRows()

◆ WriteRowsOnPage()

◆ WriteTable()