CPageTableCell_interface.h File Reference

Interface for CPageTableCell wrapper. More...

Go to the source code of this file.

Functions
CPageTableCell	CPageTableCell_Create (idrs_exception *pargException)
	Instantiates a new CPageTableCell object.
IDRS_RECT	CPageTableCell_GetBoundingBox (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the rectangle containing the column.
IDRS_INT	CPageTableCell_GetRowIndex (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the row index.
IDRS_INT	CPageTableCell_GetColIndex (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the column index.
IDRS_INT	CPageTableCell_GetRowSpan (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the rows span.
IDRS_INT	CPageTableCell_GetColSpan (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the columns span.
CPageStyleTableCell	CPageTableCell_GetCellStyle (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the cell style.
CPageTextLineArray	CPageTableCell_GetTextLines (const CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Get the array containing text lines.
void	CPageTableCell_SetBoundingBox (CPageTableCell argCPageTableCell, const IDRS_RECT *rcBoundingBox, idrs_exception *pargException)
	Set the coordinates for the bounding rectangle.
void	CPageTableCell_SetRowIndex (CPageTableCell argCPageTableCell, IDRS_INT const iRowIndex, idrs_exception *pargException)
	Set the cell row index.
void	CPageTableCell_SetColIndex (CPageTableCell argCPageTableCell, IDRS_INT const iColIndex, idrs_exception *pargException)
	Set the cell column index.
void	CPageTableCell_SetRowSpan (CPageTableCell argCPageTableCell, IDRS_INT const iRowSpan, idrs_exception *pargException)
	Set the rows span for the cell.
void	CPageTableCell_SetColSpan (CPageTableCell argCPageTableCell, IDRS_INT const iColSpan, idrs_exception *pargException)
	Set the cols span for the cell.
void	CPageTableCell_SetCellStyle (CPageTableCell argCPageTableCell, const CPageStyleTableCell argPageStyleTableCell, idrs_exception *pargException)
	Set the style associated to the table cell.
void	CPageTableCell_SetTextLines (CPageTableCell argCPageTableCell, const CPageTextLineArray argTextLines, idrs_exception *pargException)
	Set the array containing the lines of text in the cell.
void	CPageTableCell_Destroy (CPageTableCell argCPageTableCell, idrs_exception *pargException)
	Destroys a CPageTableCell handle.
CPageTableCellArray	ArrayInterface_Create_CPageTableCellArray (idrs_exception *pargException)
	Creates a new CPageTableCellArray object.

Detailed Description

Interface for CPageTableCell wrapper.

Function Documentation

ArrayInterface_Create_CPageTableCellArray()

CPageTableCellArray ArrayInterface_Create_CPageTableCellArray

(

idrs_exception *

pargException

)

Creates a new CPageTableCellArray object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CPageTableCellArray

CPageTableCell_Create()

CPageTableCell CPageTableCell_Create

(

idrs_exception *

pargException

)

Instantiates a new CPageTableCell object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to CPageCustomData methods

CPageTableCell_Destroy()

void CPageTableCell_Destroy	(	CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Destroys a CPageTableCell handle.

Parameters

argCPageTableCell	CPageTableCell handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetBoundingBox()

IDRS_RECT CPageTableCell_GetBoundingBox	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the rectangle containing the column.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetCellStyle()

CPageStyleTableCell CPageTableCell_GetCellStyle	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the cell style.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetColIndex()

IDRS_INT CPageTableCell_GetColIndex	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the column index.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetColSpan()

IDRS_INT CPageTableCell_GetColSpan	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the columns span.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetRowIndex()

IDRS_INT CPageTableCell_GetRowIndex	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the row index.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetRowSpan()

IDRS_INT CPageTableCell_GetRowSpan	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the rows span.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_GetTextLines()

CPageTextLineArray CPageTableCell_GetTextLines	(	const CPageTableCell	argCPageTableCell,
		idrs_exception *	pargException
	)

Get the array containing text lines.

Parameters

argCPageTableCell	CPageTableCell handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetBoundingBox()

void CPageTableCell_SetBoundingBox	(	CPageTableCell	argCPageTableCell,
		const IDRS_RECT *	rcBoundingBox,
		idrs_exception *	pargException
	)

Set the coordinates for the bounding rectangle.

Parameters

argCPageTableCell	CPageTableCell handle
rcBoundingBox	Bounding rectangle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetCellStyle()

void CPageTableCell_SetCellStyle	(	CPageTableCell	argCPageTableCell,
		const CPageStyleTableCell	argPageStyleTableCell,
		idrs_exception *	pargException
	)

Set the style associated to the table cell.

Parameters

argCPageTableCell	CPageTableCell handle
argPageStyleTableCell	Object containing the style associated to the cell
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetColIndex()

void CPageTableCell_SetColIndex	(	CPageTableCell	argCPageTableCell,
		IDRS_INT const	iColIndex,
		idrs_exception *	pargException
	)

Set the cell column index.

Parameters

argCPageTableCell	CPageTableCell handle
iColIndex	0 based column index
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetColSpan()

void CPageTableCell_SetColSpan	(	CPageTableCell	argCPageTableCell,
		IDRS_INT const	iColSpan,
		idrs_exception *	pargException
	)

Set the cols span for the cell.

Parameters

argCPageTableCell	CPageTableCell handle
iColSpan	Columns span value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetRowIndex()

void CPageTableCell_SetRowIndex	(	CPageTableCell	argCPageTableCell,
		IDRS_INT const	iRowIndex,
		idrs_exception *	pargException
	)

Set the cell row index.

Parameters

argCPageTableCell	CPageTableCell handle
iRowIndex	0 based row index
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetRowSpan()

void CPageTableCell_SetRowSpan	(	CPageTableCell	argCPageTableCell,
		IDRS_INT const	iRowSpan,
		idrs_exception *	pargException
	)

Set the rows span for the cell.

Parameters

argCPageTableCell	CPageTableCell handle
iRowSpan	Rows span value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTableCell_SetTextLines()

void CPageTableCell_SetTextLines	(	CPageTableCell	argCPageTableCell,
		const CPageTextLineArray	argTextLines,
		idrs_exception *	pargException
	)

Set the array containing the lines of text in the cell.

Parameters

argCPageTableCell	CPageTableCell handle
argTextLines	Array containing the lines of text in the cell
pargException	Pointer to exception structure that will be filled if an exception occurs