#include <PdfPublishSlideTable.h>

Inheritance diagram for OdPdfPublish::OdSlideTable:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdSlideTable)

	ODRX_HEAP_OPERATORS ()

	OdSlideTable ()

virtual	~OdSlideTable ()

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

void	setHTML (const OdString &source)

void	setHTMLStyle (const OdString &)

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

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

static OdRxClass *	desc ()

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

Detailed Description

This class implements a slide table entity for .pdf documents created with Teigha Publish. Slide Table is a kind of table, which implements showing a set of slides. Each cell of the slide table contains an image (slide). There are also two specific cells: A cell for Next button. Next button moves the slides forward when user presses it. A cell for Previous button. Previous button moves the slides backward when user presses it. Slide table is suitable for showing preview images for different views in .pdf document with 3D objects.

Definition at line 51 of file PdfPublishSlideTable.h.

Constructor & Destructor Documentation

◆ OdSlideTable()

OdPdfPublish::OdSlideTable::OdSlideTable ( )

Creates a slide table object.

◆ ~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 current names of previous and next buttons contained in the slide table. The method fills 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

◆ getHeader()

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

Returns current header flag value. Header flag determines whether the slide table have header (if set to true). The method fills a passed boolean value with 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 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.

◆ getHTMLStyle()

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

Returns 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.

◆ getText()

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

Returns text fields of the slide table. The method fills passed values with quantity of rows and column and adds text field smart pointers into a passed array, then returns 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] An placeholder for smart pointers to text fields.

◆ 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 forward and backward for the slide table.

Parameters

previous_button_name	[in] A name for previous button that slides backward.
next_button_name	[in] A name for next button that slides forward.

◆ setDimensions()

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

◆ setHeader()

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

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

Parameters

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

◆ setHTML()

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

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

Parameters

source [in] A new HTML markup source code.

◆ setHTMLStyle()

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

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] A new HTML markup style options.

◆ 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 rows in slide table, which should be filled with text fields.
columns	[in] A quantity of columns in slide table, which should be filled with text fields.
text	[in] An array of smart pointers to a text fields, which should be added to the slide table cells.

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

PdfPublishSlideTable.h

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