#include <PdfPublishTable.h>

Inheritance diagram for OdPdfPublish::OdTable:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdTable)

	ODRX_HEAP_OPERATORS ()

virtual	~OdTable ()

void	setLink (const OdUInt32 row, const OdUInt32 column, const OdLinkPtr &link)

void	setText (const OdUInt32 row, const OdUInt32 column, const OdTextPtr &text, const double rotation=0., const Table::TextAlignment alignment=Table::kCenter)

void	setTextMargins (const OdUInt32 left, const OdUInt32 right, const OdUInt32 bottom, const OdUInt32 top)

void	setButton (const OdUInt32 row, const OdUInt32 column, const OdButtonPtr &button)

void	setTextField (const OdUInt32 row, const OdUInt32 column, const OdTextFieldPtr &text_field)

void	getLink (const OdUInt32 row, const OdUInt32 column, OdLinkPtr &link) const

void	getText (const OdUInt32 row, const OdUInt32 column, OdTextPtr &text, double &rotation, Table::TextAlignment &alignment) const

void	getTextMargins (OdUInt32 &left, OdUInt32 &right, OdUInt32 &bottom, OdUInt32 &top) const

void	getButton (const OdUInt32 row, const OdUInt32 column, OdButtonPtr &button) const

void	getTextField (const OdUInt32 row, const OdUInt32 column, OdTextFieldPtr &text_field) const

Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)

	ODRX_HEAP_OPERATORS ()

virtual	~OdObject ()

virtual bool	isEmpty () const

virtual bool	isValid () const

virtual void	clear ()

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdTable ()

Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class implements a simple table entity for .pdf documents created with Publish SDK. Each table cell can contain one control or text label. A table can be created only using a <link OdPdfPublish::OdTableCreator, table creator object>.

Definition at line 52 of file PdfPublishTable.h.

Constructor & Destructor Documentation

◆ OdTable()

OdPdfPublish::OdTable::OdTable ( )

protected

◆ ~OdTable()

virtual OdPdfPublish::OdTable::~OdTable ( )

virtual

Destroys a table object.

Member Function Documentation

◆ getButton()

void OdPdfPublish::OdTable::getButton	(	const OdUInt32	row,
		const OdUInt32	column,
		OdButtonPtr &	button ) const

Returns a <link OdPdfPublish::OdButton, button> contained in a specified table cell. The table cell is addressed through row and column indices. The method fills a passed smart pointer with a pointer to the button object and returns it to a calling subroutine.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
button	[out] A placeholder for a smart pointer to the button object.

Returns: Returns a smart pointer to the button contained in the table cell. If the cell does not contain a button, a null pointer is returned.

See also: <link OdPdfPublish::OdButton, OdButton class>

◆ getLink()

void OdPdfPublish::OdTable::getLink	(	const OdUInt32	row,
		const OdUInt32	column,
		OdLinkPtr &	link ) const

Returns a link contained in a specified table cell. The table cell is addressed through row and column indices. The method fills a passed smart pointer with a pointer to the link object and returns it to a calling subroutine.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
link	[out] A placeholder for a smart pointer to the link object.

Returns: Returns a smart pointer to the link contained in the table cell. If the cell does not contain a link, a null pointer is returned.

◆ getText()

void OdPdfPublish::OdTable::getText	(	const OdUInt32	row,
		const OdUInt32	column,
		OdTextPtr &	text,
		double &	rotation,
		Table::TextAlignment &	alignment ) const

Returns a <link OdPdfPublish::OdText, text label> contained in a specified table cell. The table cell is addressed through row and column indices. The method fills a passed smart pointer with a pointer to the text label object and returns it to a calling subroutine.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
text	[out] A placeholder for a smart pointer to the text label object.
rotation	[out] A placeholder for the <link OdPdfPublish::OdText, text label> rotation angle.
alignment	[out] A placeholder for <link OdPdfPublish::Table::TextAlignment, alignment> for text in table cells value to be set.

Returns: Returns a smart pointer to the <link OdPdfPublish::OdText, text label> contained in the table cell. If the cell does not contain a text label, a null pointer is returned.

See also: <link OdPdfPublish::OdText, OdText class> <link OdPdfPublish::Table::TextAlignment, Table::TextAlignment enumeration>

◆ getTextField()

void OdPdfPublish::OdTable::getTextField	(	const OdUInt32	row,
		const OdUInt32	column,
		OdTextFieldPtr &	text_field ) const

Returns a <link OdPdfPublish::OdTextField, text field> contained in a specified table cell. The table cell is addressed through row and column index. The method fills a passed smart pointer with a pointer to the text field object and returns it to a calling subroutine.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
text_field	[out] A placeholder for a smart pointer to the text field object.

Returns: Returns a smart pointer to the text field contained in the table cell. If the cell does not contain a text field, a null pointer is returned.

See also: <link OdPdfPublish::OdTextField, OdTextField class>

◆ getTextMargins()

void OdPdfPublish::OdTable::getTextMargins	(	OdUInt32 &	left,
		OdUInt32 &	right,
		OdUInt32 &	bottom,
		OdUInt32 &	top ) const

Returns a margins for a table text cell.

Parameters

left	[out] A placeholder for left margin for a table text cell.
right	[out] A placeholder for right margin for a table text cell.
bottom	[out] A placeholder for bottom margin for a table text cell.
top	[out] A placeholder for top margin for a table text cell.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdTable::ODRX_DECLARE_MEMBERS ( OdTable )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdTable::ODRX_HEAP_OPERATORS ( )

◆ setButton()

void OdPdfPublish::OdTable::setButton	(	const OdUInt32	row,
		const OdUInt32	column,
		const OdButtonPtr &	button )

Sets a <link OdPdfPublish::OdButton, button> for a specified table cell. The table cell is addressed through row and column indices.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
button	[in] A smart pointer to an OdButton object that should be added.

See also: <link OdPdfPublish::OdButton, OdButton class>

◆ setLink()

void OdPdfPublish::OdTable::setLink	(	const OdUInt32	row,
		const OdUInt32	column,
		const OdLinkPtr &	link )

Sets a <link OdPdfPublish::OdLink, link> for a specified table cell. The table cell is determined by row and column indices.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
link	[in] A smart pointer to an OdLink object that should be added.

See also: <link OdPdfPublish::OdLink, OdLink class>

◆ setText()

void OdPdfPublish::OdTable::setText	(	const OdUInt32	row,
		const OdUInt32	column,
		const OdTextPtr &	text,
		const double	rotation = 0.,
		const Table::TextAlignment	alignment = Table::kCenter )

Sets a <link OdPdfPublish::OdText, text label> for a specified table cell. The table cell is addressed through row and column indices.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
text	[in] A smart pointer to an <link OdPdfPublish::OdText, OdText object> that should be added.
rotation	[in] A rotation angle value to be set.
alignment	[in] A alignment for text in table cells value to be set.

See also: <link OdPdfPublish::OdText, OdText class> <link OdPdfPublish::Table::TextAlignment, Table::TextAlignment enumeration>

◆ setTextField()

void OdPdfPublish::OdTable::setTextField	(	const OdUInt32	row,
		const OdUInt32	column,
		const OdTextFieldPtr &	text_field )

Sets a <link OdPdfPublish::OdTextField, text field> for a specified table cell. The table cell is addressed through row and column indices.

Parameters

row	[in] A table row index. Can accept values from 0 to the table row quantity - 1.
column	[in] A table column index. Can accept values from 0 to the table column quantity - 1.
text_field	[in] A smart pointer to an OdTextField object that should be added.

See also: <link OdPdfPublish::OdTextField, OdTextField class>

◆ setTextMargins()

void OdPdfPublish::OdTable::setTextMargins	(	const OdUInt32	left,
		const OdUInt32	right,
		const OdUInt32	bottom,
		const OdUInt32	top )

Sets a margins for a table text cell.

Parameters

left	[in] A left margin for a table text cell.
right	[in] A right margin for a table text cell.
bottom	[in] A bottom margin for a table text cell.
top	[in] A top margin for a table text cell.

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

PdfPublishTable.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdTable()

◆ ~OdTable()

Member Function Documentation

◆ getButton()

◆ getLink()

◆ getText()

◆ getTextField()

◆ getTextMargins()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setButton()

◆ setLink()

◆ setText()

◆ setTextField()

◆ setTextMargins()