PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfTableModel Class Referenceabstract

#include <PdfTable.h>

Inheritance diagram for PoDoFo::PdfTableModel:
PoDoFo::PdfSimpleTableModel

Public Member Functions

virtual PdfString GetText (int col, int row) const =0
 
virtual EPdfAlignment GetAlignment (int col, int row) const =0
 
virtual EPdfVerticalAlignment GetVerticalAlignment (int col, int row) const =0
 
virtual PdfFontGetFont (int col, int row) const =0
 
virtual bool HasBackgroundColor (int col, int row) const =0
 
virtual PdfColor GetBackgroundColor (int col, int row) const =0
 
virtual PdfColor GetForegroundColor (int col, int row) const =0
 
virtual bool HasWordWrap (int col, int row) const =0
 
virtual bool HasBorders () const =0
 
virtual double GetBorderWidth () const =0
 
virtual PdfColor GetBorderColor (int col, int row) const =0
 
virtual bool HasImage (int col, int row) const =0
 
virtual PdfImageGetImage (int col, int row) const =0
 

Detailed Description

This is an abstract interface of a model that can provide data and formatting informations to a PdfTable.

You can implement your own PdfTableModel to supply data to a PdfTable. PdfSimpleTableModel is an example of a simple model.

See also
PdfTable
PdfSimpleTableModel

Member Function Documentation

virtual EPdfAlignment PoDoFo::PdfTableModel::GetAlignment ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the horizontal alignment of the contents in the cell

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfColor PoDoFo::PdfTableModel::GetBackgroundColor ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the background color of the specified cell

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfColor PoDoFo::PdfTableModel::GetBorderColor ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the border color

Implemented in PoDoFo::PdfSimpleTableModel.

virtual double PoDoFo::PdfTableModel::GetBorderWidth ( ) const
pure virtual
Returns
the stroke witdth of the border line

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfFont* PoDoFo::PdfTableModel::GetFont ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the font of this table cell or NULL to use the default font

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfColor PoDoFo::PdfTableModel::GetForegroundColor ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the foreground (text) color of the specified cell

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfImage* PoDoFo::PdfTableModel::GetImage ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the image for the specified cell or NULL if the cell has no image

Implemented in PoDoFo::PdfSimpleTableModel.

virtual PdfString PoDoFo::PdfTableModel::GetText ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the contents string of this table cell

Implemented in PoDoFo::PdfSimpleTableModel.

virtual EPdfVerticalAlignment PoDoFo::PdfTableModel::GetVerticalAlignment ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
the vertical alignment of the contents in the cell

Implemented in PoDoFo::PdfSimpleTableModel.

virtual bool PoDoFo::PdfTableModel::HasBackgroundColor ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
true if this cell has a background color

Implemented in PoDoFo::PdfSimpleTableModel.

virtual bool PoDoFo::PdfTableModel::HasBorders ( ) const
pure virtual
Returns
true if the table should have a border around all cells.
false if no cell border should be visible

Cell borders are always drawn using the current PdfPainter settings.

Implemented in PoDoFo::PdfSimpleTableModel.

virtual bool PoDoFo::PdfTableModel::HasImage ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
true if the table cell contains an image

Implemented in PoDoFo::PdfSimpleTableModel.

virtual bool PoDoFo::PdfTableModel::HasWordWrap ( int  col,
int  row 
) const
pure virtual
Parameters
colthe column of the table cell
rowthe row of the table cell
Returns
true if the specified cell should use wordwrapping

Implemented in PoDoFo::PdfSimpleTableModel.