wxPdfCellContext Class Reference

#include <pdfxml.h>

Public Member Functions
	wxPdfCellContext (double maxWidth, wxPdfAlignment hAlign=wxPDF_ALIGN_JUSTIFY, wxPdfAlignment vAlign=wxPDF_ALIGN_TOP)
	Constructor.
virtual	~wxPdfCellContext ()
	Destructor.
void	AddHeight (double height)
	Increase total height of cell.
double	GetHeight ()
	Get total height of cell.
double	GetMaxWidth ()
	Get maximum width of cell.
wxPdfAlignment	GetHAlign ()
	Get horizontal alignment.
void	SetVAlign (wxPdfAlignment vAlign)
	Set vertical alignment.
wxPdfAlignment	GetVAlign ()
	Get vertical alignment.
void	AddLine ()
	Add a line to cell.
unsigned int	GetLineCount ()
	Get number of lines in cell.
void	AddLastLineValues (double width, int spaces)
	Add width and number of spaces of the last line of the current context.
double	GetLastLineWidth ()
	Get the width of the last line.
void	MarkLastLine ()
	Mark the current line as the last line.
bool	IsCurrentLineMarked ()
	Check whether current line is marked as last line.
void	AddCurrentLineWidth (double width)
	Adjust width of current line.
void	AddCurrentLineSpaces (int spaces)
	Adjust number of spaces of current line.
double	GetCurrentLineWidth ()
	Get width of current line.
int	GetCurrentLineSpaces ()
	Get number of spaces of current line.
unsigned int	GetCurrentLine ()
	Get number of current line.
void	IncrementCurrentLine ()
	Increment line counter.
double	GetLineDelta ()
	Get line delta measure.
bool	GetAligned ()
	Check whether alignment has been taken care of.
void	SetAligned ()
	Set flag that alignment has been taken care of.
int	GetFillStyle ()
	Get cell fill style.
void	SetFillStyle (int fillStyle)
	Set cell fill style.
unsigned int	GetContextCount ()
	Get the number of contexts.
void	IncrementCurrentContext ()
	Increment current context.
wxPdfCellContext *	GetCurrentContext ()
	Get current context.
void	AppendContext (wxPdfCellContext *context)
	Append context to context list.
void	SetLastChar (wxUniChar c)
	Remember the last character of the last chunk.
wxUniChar	GetLastChar ()
	Get last character of previous chunk.
void	SetLastSpaceWidth (double w)
	Remember the width of the last space character.
double	GetLastSpaceWidth ()
	Get width of last space character.
void	SetCharacterSpacing (double charSpacing)
	Remember the character spacing.
double	GetCharacterSpacing ()
	Get character spacing.
void	SetHRef (const wxString &href)
	Set hyper link reference.
wxString &	GetHRef ()
	Get hyper link reference.
void	SetTable (wxPdfTable *table)
	Set reference to an embedded markup table.
wxPdfTable *	GetTable ()
	Get reference to an embedded markup table.

Detailed Description

Class representing cell context objects. (For internal use only)

Constructor & Destructor Documentation

wxPdfCellContext()

wxPdfCellContext::wxPdfCellContext	(	double	maxWidth,
		wxPdfAlignment	hAlign = wxPDF_ALIGN_JUSTIFY,
		wxPdfAlignment	vAlign = wxPDF_ALIGN_TOP )

Constructor.

Parameters

maxWidth	Maximum allowed width for the cell
hAlign	Horizontal alignment
vAlign	Vertical alignment

~wxPdfCellContext()

virtual wxPdfCellContext::~wxPdfCellContext ( )

virtual

Destructor.

Member Function Documentation

AddCurrentLineSpaces()

void wxPdfCellContext::AddCurrentLineSpaces

(

int

spaces

)

Adjust number of spaces of current line.

Parameters

spaces

Number of spaces to add

AddCurrentLineWidth()

void wxPdfCellContext::AddCurrentLineWidth

(

double

width

)

Adjust width of current line.

Parameters

width

Width to add

AddHeight()

void wxPdfCellContext::AddHeight ( double height )

inline

Increase total height of cell.

Parameters

height

Height to add

AddLastLineValues()

void wxPdfCellContext::AddLastLineValues	(	double	width,
		int	spaces )

Add width and number of spaces of the last line of the current context.

Parameters

width	Line width
spaces	Number of spaces

AddLine()

void wxPdfCellContext::AddLine

(

)

Add a line to cell.

AppendContext()

void wxPdfCellContext::AppendContext

(

wxPdfCellContext *

context

)

Append context to context list.

Parameters

context

Pointer to cell context to append

GetAligned()

bool wxPdfCellContext::GetAligned ( )

inline

Check whether alignment has been taken care of.

Returns

true if aligned, false otherwise

GetCharacterSpacing()

double wxPdfCellContext::GetCharacterSpacing ( )

inline

Get character spacing.

Returns

Character spacing

GetContextCount()

unsigned int wxPdfCellContext::GetContextCount ( )

inline

Get the number of contexts.

Returns

Number of contexts

GetCurrentContext()

wxPdfCellContext * wxPdfCellContext::GetCurrentContext

(

)

Get current context.

Returns

Pointer to current cell context

GetCurrentLine()

unsigned int wxPdfCellContext::GetCurrentLine ( )

inline

Get number of current line.

Returns

Current line index

GetCurrentLineSpaces()

int wxPdfCellContext::GetCurrentLineSpaces

(

)

Get number of spaces of current line.

Returns

Number of spaces

GetCurrentLineWidth()

double wxPdfCellContext::GetCurrentLineWidth

(

)

Get width of current line.

Returns

Current line width

GetFillStyle()

int wxPdfCellContext::GetFillStyle ( )

inline

Get cell fill style.

Returns

Fill style

GetHAlign()

wxPdfAlignment wxPdfCellContext::GetHAlign ( )

inline

Get horizontal alignment.

Returns

Horizontal alignment

GetHeight()

double wxPdfCellContext::GetHeight ( )

inline

Get total height of cell.

Returns

Total height

GetHRef()

wxString & wxPdfCellContext::GetHRef ( )

inline

Get hyper link reference.

Returns

Reference to hyperlink string

GetLastChar()

wxUniChar wxPdfCellContext::GetLastChar ( )

inline

Get last character of previous chunk.

Returns

Last character

GetLastLineWidth()

double wxPdfCellContext::GetLastLineWidth

(

)

Get the width of the last line.

Returns

Last line width

GetLastSpaceWidth()

double wxPdfCellContext::GetLastSpaceWidth ( )

inline

Get width of last space character.

Returns

Space width

GetLineCount()

unsigned int wxPdfCellContext::GetLineCount ( )

inline

Get number of lines in cell.

Returns

Number of lines

GetLineDelta()

double wxPdfCellContext::GetLineDelta

(

)

Get line delta measure.

Returns

Line delta

GetMaxWidth()

double wxPdfCellContext::GetMaxWidth ( )

inline

Get maximum width of cell.

Returns

Maximum width

GetTable()

wxPdfTable * wxPdfCellContext::GetTable ( )

inline

Get reference to an embedded markup table.

Returns

Pointer to the embedded table object

GetVAlign()

wxPdfAlignment wxPdfCellContext::GetVAlign ( )

inline

Get vertical alignment.

Returns

Vertical alignment

IncrementCurrentContext()

void wxPdfCellContext::IncrementCurrentContext

(

)

Increment current context.

IncrementCurrentLine()

void wxPdfCellContext::IncrementCurrentLine

(

)

Increment line counter.

IsCurrentLineMarked()

bool wxPdfCellContext::IsCurrentLineMarked

(

)

Check whether current line is marked as last line.

Returns

true if current line is the last line, false otherwise

MarkLastLine()

void wxPdfCellContext::MarkLastLine

(

)

Mark the current line as the last line.

SetAligned()

void wxPdfCellContext::SetAligned ( )

inline

Set flag that alignment has been taken care of.

SetCharacterSpacing()

void wxPdfCellContext::SetCharacterSpacing ( double charSpacing )

inline

Remember the character spacing.

Parameters

charSpacing

Character spacing

SetFillStyle()

void wxPdfCellContext::SetFillStyle ( int fillStyle )

inline

Set cell fill style.

Parameters

fillStyle

Fill style

SetHRef()

void wxPdfCellContext::SetHRef ( const wxString & href )

inline

Set hyper link reference.

Parameters

href	Hyperlink reference

SetLastChar()

void wxPdfCellContext::SetLastChar ( wxUniChar c )

inline

Remember the last character of the last chunk.

Parameters

c	Character to remember

SetLastSpaceWidth()

void wxPdfCellContext::SetLastSpaceWidth ( double w )

inline

Remember the width of the last space character.

Parameters

w	Space width

SetTable()

void wxPdfCellContext::SetTable ( wxPdfTable * table )

inline

Set reference to an embedded markup table.

Parameters

table

Pointer to the embedded table object

SetVAlign()

void wxPdfCellContext::SetVAlign ( wxPdfAlignment vAlign )

inline

Set vertical alignment.

Parameters

vAlign

Vertical alignment

---

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

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