HPS::Publish::TableKit Class Reference

The TableKit class is a user space object. More...

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::TableKit:

Collaboration diagram for HPS::Publish::TableKit:

Public Member Functions
	TableKit ()
	The default constructor creates an empty TableKit object. More...
	TableKit (TableKit const &in_kit)
	The copy constructor creates a new TableKit object that contains the same settings as the source TableKit. More...
	TableKit (TableKit &&in_kit)
	The move constructor creates a TableKit by transferring the underlying object of the rvalue reference to this TableKit. More...
virtual	~TableKit ()
HPS::Type	ObjectType () const
void	Set (TableKit const &in_kit)
	Copies the source TableKit into this TableKit. More...
void	Show (TableKit &out_kit) const
	Copies this TableKit into the given TableKit. More...
TableKit &	operator= (TableKit const &in_kit)
	Copies the source TableKit into this TableKit. More...
TableKit &	operator= (TableKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this TableKit. More...
bool	Empty () const
	Indicates whether this TableKit has any values set on it. More...
bool	Equals (TableKit const &in_kit) const
	Check if the source TableKit is equivalent to this TableKit. More...
bool	operator== (TableKit const &in_kit) const
	Check if the source TableKit is equivalent to this TableKit. More...
bool	operator!= (TableKit const &in_kit) const
	Check if the source TableKit is not equivalent to this TableKit. More...
TableKit &	SetHTML (char const *in_source, Source::Type in_type=Source::Type::Code)
	Sets the HTML table source or file. More...
TableKit &	SetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code)
	Sets the HTML table style source or file. More...
TableKit &	SetLink (int in_row, int in_column, LinkKit const &in_link)
	Adds a link to this table at the specified row and column. More...
TableKit &	SetText (int in_row, int in_column, TextKit const &in_text)
	Adds text to this table at the specified row and column. More...
TableKit &	SetButton (int in_row, int in_column, ButtonKit const &in_button)
	Adds a button to this table at the specified row and column. More...
TableKit &	SetTextField (int in_row, int in_column, TextFieldKit const &in_text_field)
	Adds a text field to this table at the specified row and column. More...
TableKit &	UnsetHTML ()
	Removes the HTML table setting. More...
TableKit &	UnsetHTMLStyle ()
	Removes the HTML table style setting. More...
TableKit &	UnsetLink (int in_row, int in_column)
	Removes the link at the specified row and column. More...
TableKit &	UnsetText (int in_row, int in_column)
	Removes the text at the specified row and column. More...
TableKit &	UnsetButton (int in_row, int in_column)
	Removes the button at the specified row and column. More...
TableKit &	UnsetTextField (int in_row, int in_column)
	Removes the text field at the specified row and column. More...
TableKit &	UnsetEverything ()
	Removes all data from the table. More...
bool	ShowHTML (UTF8 &out_source, Source::Type &out_type) const
	Shows the HTML table setting. More...
bool	ShowHTMLStyle (UTF8 &out_source, Source::Type &out_type) const
	Shows the HTML table style setting. More...
bool	ShowLink (int in_row, int in_column, LinkKit &out_link) const
	Shows the link at the specified row and column. More...
bool	ShowText (int in_row, int in_column, TextKit &out_text) const
	Shows the text at the specified row and column. More...
bool	ShowButton (int in_row, int in_column, ButtonKit &out_button) const
	Shows the button at the specified row and column. More...
bool	ShowTextField (int in_row, int in_column, TextFieldKit &out_text_field) const
	Shows the link at the specified row and column. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PublishTableKit

Detailed Description

The TableKit class is a user space object.

It acts as the container for all data that can be used to specify a table for a Publish PDF.

Warning

The TableToPDF Publish add-on must be installed in order to use this class.

Constructor & Destructor Documentation

TableKit() [1/3]

HPS::Publish::TableKit::TableKit

(

)

The default constructor creates an empty TableKit object.

TableKit() [2/3]

HPS::Publish::TableKit::TableKit

(

TableKit const &

in_kit

)

The copy constructor creates a new TableKit object that contains the same settings as the source TableKit.

Parameters

in_kit

The source TableKit to copy.

TableKit() [3/3]

HPS::Publish::TableKit::TableKit

(

TableKit &&

in_kit

)

The move constructor creates a TableKit by transferring the underlying object of the rvalue reference to this TableKit.

Parameters

in_kit

An rvalue reference to a TableKit to take the underlying object from.

~TableKit()

virtual HPS::Publish::TableKit::~TableKit ( )

virtual

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

bool HPS::Publish::TableKit::Empty ( ) const

virtual

Indicates whether this TableKit has any values set on it.

Returns

true if no values are set on this TableKit, false otherwise.

Reimplemented from HPS::Object.

Equals()

bool HPS::Publish::TableKit::Equals

(

TableKit const &

in_kit

)

const

Check if the source TableKit is equivalent to this TableKit.

Parameters

in_kit

The source TableKit to compare to this TableKit.

Returns

true if the objects are equivalent, false otherwise.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::Publish::TableKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::TableKit::operator!=

(

TableKit const &

in_kit

)

const

Check if the source TableKit is not equivalent to this TableKit.

Parameters

in_kit

The source TableKit to compare to this TableKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

TableKit& HPS::Publish::TableKit::operator=

(

TableKit const &

in_kit

)

Copies the source TableKit into this TableKit.

Parameters

in_kit

The source TableKit to copy.

Returns

A reference to this TableKit.

operator=() [2/2]

TableKit& HPS::Publish::TableKit::operator=

(

TableKit &&

in_kit

)

The move assignment operator transfers the underlying object of the rvalue reference to this TableKit.

Parameters

in_kit

An rvalue reference to a TableKit to take the underlying object from.

Returns

A reference to this TableKit.

operator==()

bool HPS::Publish::TableKit::operator==

(

TableKit const &

in_kit

)

const

Check if the source TableKit is equivalent to this TableKit.

Parameters

in_kit

The source TableKit to compare to this TableKit.

Returns

true if the objects are equivalent, false otherwise.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Set()

void HPS::Publish::TableKit::Set

(

TableKit const &

in_kit

)

Copies the source TableKit into this TableKit.

Parameters

in_kit

The source TableKit to copy.

SetButton()

TableKit& HPS::Publish::TableKit::SetButton	(	int	in_row,
		int	in_column,
		ButtonKit const &	in_button
	)

Adds a button to this table at the specified row and column.

This corresponds to the value that will be passed to A3DPDFPageInsertButtonInTable.

Parameters

in_row	Row in which to add the button.
in_column	Column in which to add the button.
in_button	Button to add at the specified row and column in the table.

Returns

A reference to this TableKit.

SetHTML()

TableKit& HPS::Publish::TableKit::SetHTML	(	char const *	in_source,
		Source::Type	in_type = Source::Type::Code
	)

Sets the HTML table source or file.

Parameters

in_source	UTF8-encoded HTML table source or file (depending on the following argument).
in_type	The type of the preceding argument. Defaults to Source::Type::Code.

Returns

A reference to this TableKit.

SetHTMLStyle()

TableKit& HPS::Publish::TableKit::SetHTMLStyle	(	char const *	in_source,
		Source::Type	in_type = Source::Type::Code
	)

Sets the HTML table style source or file.

Parameters

in_source	UTF8-encoded HTML table style source or file (depending on the following argument).
in_type	Type of the preceding argument.

Returns

A reference to this TableKit.

SetLink()

TableKit& HPS::Publish::TableKit::SetLink	(	int	in_row,
		int	in_column,
		LinkKit const &	in_link
	)

Adds a link to this table at the specified row and column.

This corresponds to the value that will be passed to A3DPDFPageInsertLinkInTable.

Parameters

in_row	Row in which to add the link.
in_column	Column in which to add the link.
in_link	Link to add at the specified row and column in the table.

Returns

A reference to this TableKit.

SetText()

TableKit& HPS::Publish::TableKit::SetText	(	int	in_row,
		int	in_column,
		TextKit const &	in_text
	)

Adds text to this table at the specified row and column.

This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.

Parameters

in_row	Row in which to add the text.
in_column	Column in which to add the text.
in_text	Text to add at the specified row and column in the table.

Returns

A reference to this TableKit.

SetTextField()

TableKit& HPS::Publish::TableKit::SetTextField	(	int	in_row,
		int	in_column,
		TextFieldKit const &	in_text_field
	)

Adds a text field to this table at the specified row and column.

This corresponds to the value that will be passed to A3DPDFPageInsertTextFieldInTable.

Parameters

in_row	Row in which to add the text field.
in_column	Column in which to add the text field.
in_text_field	Text field to add at the specified row and column in the table.

Returns

A reference to this TableKit.

Show()

void HPS::Publish::TableKit::Show

(

TableKit &

out_kit

)

const

Copies this TableKit into the given TableKit.

Parameters

out_kit

The TableKit to populate with the contents of this TableKit.

ShowButton()

bool HPS::Publish::TableKit::ShowButton	(	int	in_row,
		int	in_column,
		ButtonKit &	out_button
	)		const

Shows the button at the specified row and column.

Parameters

in_row	Row in which to show the button.
in_column	Column in which to show the button.
out_button	The button at the specified row and column in the table.

Returns

true if a button was added at the specified row and column, false otherwise.

ShowHTML()

bool HPS::Publish::TableKit::ShowHTML	(	UTF8 &	out_source,
		Source::Type &	out_type
	)		const

Shows the HTML table setting.

Parameters

out_source	The HTML table source or file (depending on the following argument).
out_type	The type of the preceding argument.

Returns

true if an HTML table was specified, false otherwise.

ShowHTMLStyle()

bool HPS::Publish::TableKit::ShowHTMLStyle	(	UTF8 &	out_source,
		Source::Type &	out_type
	)		const

Shows the HTML table style setting.

Parameters

out_source	The HTML table style source or file (depending on the following argument).
out_type	The type of the preceding argument.

Returns

true if an HTML table style was specified, false otherwise.

ShowLink()

bool HPS::Publish::TableKit::ShowLink	(	int	in_row,
		int	in_column,
		LinkKit &	out_link
	)		const

Shows the link at the specified row and column.

Parameters

in_row	Row in which to show the link.
in_column	Column in which to show the link.
out_link	The link at the specified row and column in the table.

Returns

true if a link was added at the specified row and column, false otherwise.

ShowText()

bool HPS::Publish::TableKit::ShowText	(	int	in_row,
		int	in_column,
		TextKit &	out_text
	)		const

Shows the text at the specified row and column.

Parameters

in_row	Row in which to show the text.
in_column	Column in which to show the text.
out_text	The text at the specified row and column in the table.

Returns

true if text was added at the specified row and column, false otherwise.

ShowTextField()

bool HPS::Publish::TableKit::ShowTextField	(	int	in_row,
		int	in_column,
		TextFieldKit &	out_text_field
	)		const

Shows the link at the specified row and column.

Parameters

in_row	Row in which to show the link.
in_column	Column in which to show the link.
out_text_field	The text field at the specified row and column in the table.

Returns

true if a link was added at the specified row and column, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns

The true type of the object in question.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetButton()

TableKit& HPS::Publish::TableKit::UnsetButton	(	int	in_row,
		int	in_column
	)

Removes the button at the specified row and column.

Returns

A reference to this TableKit.

UnsetEverything()

TableKit& HPS::Publish::TableKit::UnsetEverything

(

)

Removes all data from the table.

Returns

A reference to this TableKit.

UnsetHTML()

TableKit& HPS::Publish::TableKit::UnsetHTML

(

)

Removes the HTML table setting.

Returns

A reference to this TableKit.

UnsetHTMLStyle()

TableKit& HPS::Publish::TableKit::UnsetHTMLStyle

(

)

Removes the HTML table style setting.

Returns

A reference to this TableKit.

UnsetLink()

TableKit& HPS::Publish::TableKit::UnsetLink	(	int	in_row,
		int	in_column
	)

Removes the link at the specified row and column.

Returns

A reference to this TableKit.

UnsetText()

TableKit& HPS::Publish::TableKit::UnsetText	(	int	in_row,
		int	in_column
	)

Removes the text at the specified row and column.

Returns

A reference to this TableKit.

UnsetTextField()

TableKit& HPS::Publish::TableKit::UnsetTextField	(	int	in_row,
		int	in_column
	)

Removes the text field at the specified row and column.

Returns

A reference to this TableKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::TableKit::staticType = HPS::Type::PublishTableKit

static

---

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

• sprk_publish.h