#include <PdfPublishSlideTable.h>

Inheritance diagram for OdPdfPublish::OdSlideTable:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdSlideTable)

	ODRX_HEAP_OPERATORS ()

virtual	~OdSlideTable ()

void	setDimensions (const OdDoubleArray &column_proportions, const OdUInt32 row_height)

void	setHTML (const OdString &source)

void	setHTMLStyle (const OdString &source)

void	setButtons (const OdString &previous_button_name, const OdString &next_button_name)

void	setText (const OdUInt32 rows, const OdUInt32 columns, const OdTextFieldPtrArray &text)

void	setHeader (bool state)

void	getDimensions (OdDoubleArray &column_proportions, OdUInt32 &row_height) const

void	getHTML (OdString &source) const

void	getHTMLStyle (OdString &source) const

void	getButtons (OdString &previous_button_name, OdString &next_button_name) const

void	getText (OdUInt32 &rows, OdUInt32 &columns, OdTextFieldPtrArray &text) const

void	getHeader (bool &state) 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
	OdSlideTable ()

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 ()

Detailed Description

This class implements a slide table entity for .pdf documents created with Publish SDK. A slide table contains a scrollbar (by default) or two specific buttons (if their names are specified with the <link OdPdfPublish::OdSlideTable::setButtons@OdString&@OdString&, setButtons() method>): Next button. When a user presses this button, the table content is scrolled one row downwards. Previous button. When a user presses this button, the the table content is scrolled one row upwards.

Definition at line 50 of file PdfPublishSlideTable.h.

Constructor & Destructor Documentation

◆ OdSlideTable()

OdPdfPublish::OdSlideTable::OdSlideTable ( )

protected

◆ ~OdSlideTable()

virtual OdPdfPublish::OdSlideTable::~OdSlideTable ( )

virtual

Destroys a slide table object.

Member Function Documentation

◆ getButtons()

void OdPdfPublish::OdSlideTable::getButtons	(	OdString &	previous_button_name,
		OdString &	next_button_name
	)		const

Returns the current names of the previous and next buttons contained in the slide table. The method fills the passed string objects with previous and next button names and returns them to a calling subroutine.

Parameters

previous_button_name	[out] A placeholder for the previous button name.
next_button_name	[out] A placeholder for the next button name.

◆ getDimensions()

void OdPdfPublish::OdSlideTable::getDimensions	(	OdDoubleArray &	column_proportions,
		OdUInt32 &	row_height
	)		const

Returns the current column width proportions and row height for the slide table. The method fills the passed double array and integer value with the current column width proportions and row height value, then returns them to a calling subroutine.

Parameters

column_proportions	[out] A placeholder for column width proportions.
row_height	[out] A placeholder for the row height value.

Remarks: The column_proportions parameter defines the width of columns in proportional units with a range between 0.0 and 1.0. The sum of column width proportions must be equal to 1.0. The size of the slide table is determined by the location rectangle passed to the <link OdPdfPublish::OdPage::addSlideTable@OdSlideTablePtr&@OdRect&, addSlideTable()> method of the <link OdPdfPublish::OdPage> page object.

◆ getHeader()

void OdPdfPublish::OdSlideTable::getHeader ( bool & state ) const

Returns the current header flag value. The header flag determines whether the slide table has a header (if set to true). The method fills a passed boolean value with a header flag value and returns it to a calling subroutine.

Parameters

state [in] A placeholder for the header flag value.

◆ getHTML()

void OdPdfPublish::OdSlideTable::getHTML ( OdString & source ) const

Returns the current HTML markup source code for the slide table. The HTML markup source code is represented with a string in UTF8 format. The method fills a passed string object with HTML source code and returns it to a calling subroutine.

Parameters

source [out] A placeholder for the HTML markup source code.

Remarks: This functionality is not implemented yet.

◆ getHTMLStyle()

void OdPdfPublish::OdSlideTable::getHTMLStyle ( OdString & source ) const

Returns the current style options for the HTML markup of the slide table. The HTML markup style options are represented with a string in UTF8 format. The method fills a passed string object and returns it to a calling subroutine.

Parameters

source [in] A placeholder for the HTML markup style options.

Remarks: This functionality is not implemented yet.

◆ getText()

void OdPdfPublish::OdSlideTable::getText	(	OdUInt32 &	rows,
		OdUInt32 &	columns,
		OdTextFieldPtrArray &	text
	)		const

Returns the text fields of the slide table. The method fills the passed values with the quantity of rows and columns and adds text field smart pointers into a passed array, then returns the filled values and array to a calling subroutine.

Parameters

rows	[out] A placeholder for the quantity of slide table rows.
columns	[out] A placeholder for the quantity of slide table columns.
text	[out] A placeholder for smart pointers to text fields.

Remarks: The method fills the passed array of <link OdPdfPublish::OdTextField, text fields> that contain text and styles for the appropriate table cells. The quantity of the text field array elements is equal to the product of the rows and columns parameter values.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdSlideTable::ODRX_DECLARE_MEMBERS ( OdSlideTable )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdSlideTable::ODRX_HEAP_OPERATORS ( )

◆ setButtons()

void OdPdfPublish::OdSlideTable::setButtons	(	const OdString &	previous_button_name,
		const OdString &	next_button_name
	)

Sets special buttons for sliding rows upwards and downwards in the slide table.

Parameters

previous_button_name	[in] A name for the Previous button that slides rows upwards.
next_button_name	[in] A name for the Next button that slides rows downwards.

Remarks: The method allows you to set only names of buttons and not captions (text strings, which are displayed at buttons). If you set Next and Previous buttons names, scrolling is implemented with these buttons. If the names of buttons are empty (by default), scrolling is implemented with a scrollbar.

◆ setDimensions()

void OdPdfPublish::OdSlideTable::setDimensions	(	const OdDoubleArray &	column_proportions,
		const OdUInt32	row_height
	)

Sets column width proportions and row height for the slide table.

Parameters

column_proportions	[in] An array that contains column width proportions. The array size should match the count of the slide table columns.
row_height	[in] A new row height value.

Remarks: The column_proportions parameter defines the width of columns in proportional units with a range between 0.0 and 1.0. The sum of column width proportions must be equal to 1.0. The size of the slide table is determined by the location rectangle passed to the <link OdPdfPublish::OdPage::addSlideTable@OdSlideTablePtr&@OdRect&, addSlideTable()> method of the <link OdPdfPublish::OdPage> page object.

◆ setHeader()

void OdPdfPublish::OdSlideTable::setHeader ( bool state )

Sets a header flag value. The header flag determines whether the slide table has a header (if set to true).

Parameters

state [in] A new value of the header flag.

◆ setHTML()

void OdPdfPublish::OdSlideTable::setHTML ( const OdString & source )

Sets HTML markup source code for the slide table. The HTML markup source code is represented with a string in UTF8 format.

Parameters

source [in] New HTML markup source code.

Remarks: This functionality is not implemented yet.

◆ setHTMLStyle()

void OdPdfPublish::OdSlideTable::setHTMLStyle ( const OdString & source )

Sets style options for the HTML markup of the slide table. The HTML markup style options are represented with a string in UTF8 format.

Parameters

source [in] New HTML markup style options.

Remarks: This functionality is not implemented yet.

◆ setText()

void OdPdfPublish::OdSlideTable::setText	(	const OdUInt32	rows,
		const OdUInt32	columns,
		const OdTextFieldPtrArray &	text
	)

Adds text fields for slide table cells.

Parameters

rows	[in] A quantity of slide table rows that should be filled with text fields.
columns	[in] A quantity of slide table columns that should be filled with text fields.
text	[in] An array of smart pointers to text fields that should be added to the slide table cells.

Remarks: The text for the table is specified with an array of <link OdPdfPublish::OdTextField, text fields>, which contain text and styles for appropriate table cells. The quantity of the text field array elements must be equal to the product of the rows and columns parameter values.

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

PdfPublishSlideTable.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdSlideTable()

◆ ~OdSlideTable()

Member Function Documentation

◆ getButtons()

◆ getDimensions()

◆ getHeader()

◆ getHTML()

◆ getHTMLStyle()

◆ getText()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setButtons()

◆ setDimensions()

◆ setHeader()

◆ setHTML()

◆ setHTMLStyle()

◆ setText()