HPS::Publish::SlideTableKit Class Reference

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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::SlideTableKit:

Collaboration diagram for HPS::Publish::SlideTableKit:

Public Member Functions
	SlideTableKit ()
	The default constructor creates an empty SlideTableKit object. More...
	SlideTableKit (SlideTableKit const &in_kit)
	The copy constructor creates a new SlideTableKit object that contains the same settings as the source SlideTableKit. More...
	SlideTableKit (SlideTableKit &&in_kit)
	The move constructor creates a SlideTableKit by transferring the underlying object of the rvalue reference to this SlideTableKit. More...
virtual	~SlideTableKit ()
HPS::Type	ObjectType () const
void	Set (SlideTableKit const &in_kit)
	Copies the source SlideTableKit into this SlideTableKit. More...
void	Show (SlideTableKit &out_kit) const
	Copies this SlideTableKit into the given SlideTableKit. More...
SlideTableKit &	operator= (SlideTableKit const &in_kit)
	Copies the source SlideTableKit into this SlideTableKit. More...
SlideTableKit &	operator= (SlideTableKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this SlideTableKit. More...
bool	Empty () const
	Indicates whether this SlideTableKit has any values set on it. More...
bool	Equals (SlideTableKit const &in_kit) const
	Check if the source SlideTableKit is equivalent to this SlideTableKit. More...
bool	operator== (SlideTableKit const &in_kit) const
	Check if the source SlideTableKit is equivalent to this SlideTableKit. More...
bool	operator!= (SlideTableKit const &in_kit) const
	Check if the source SlideTableKit is not equivalent to this SlideTableKit. More...
SlideTableKit &	SetHTML (char const *in_source, Source::Type in_type=Source::Type::Code)
	Sets the HTML table source or file. More...
SlideTableKit &	SetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code)
	Sets the HTML table style source or file. More...
SlideTableKit &	SetButtons (char const *in_previous_button_name, char const *in_next_button_name)
	Sets the button names for the slide table. More...
SlideTableKit &	SetText (size_t in_rows, size_t in_columns, TextFieldKit const in_text[])
	Sets the text strings for the slide table. More...
SlideTableKit &	SetText (size_t in_rows, size_t in_columns, TextFieldKitArray const &in_text)
	Sets the text strings for the slide table. More...
SlideTableKit &	SetHeader (bool in_state)
	Sets whether this slide table has a header. More...
SlideTableKit &	UnsetHTML ()
	Removes the HTML table setting. More...
SlideTableKit &	UnsetHTMLStyle ()
	Removes the HTML table style setting. More...
SlideTableKit &	UnsetButtons ()
	Removes the buttons setting. More...
SlideTableKit &	UnsetText ()
	Removes the text strings setting. More...
SlideTableKit &	UnsetHeader ()
	Removes the header setting. More...
SlideTableKit &	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	ShowButtons (UTF8 &out_previous_button_name, UTF8 &out_next_button_name) const
	Shows the buttons setting. More...
bool	ShowText (size_t &out_rows, size_t &out_columns, TextFieldKitArray &out_text) const
	Shows the text strings setting. More...
bool	ShowHeader (bool &out_state) const
	Shows the header setting. 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::PublishSlideTableKit

Detailed Description

The SlideTableKit class is a user space object.

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

Warning

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

Constructor & Destructor Documentation

SlideTableKit() [1/3]

HPS::Publish::SlideTableKit::SlideTableKit

(

)

The default constructor creates an empty SlideTableKit object.

SlideTableKit() [2/3]

HPS::Publish::SlideTableKit::SlideTableKit

(

SlideTableKit const &

in_kit

)

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

Parameters

in_kit

The source SlideTableKit to copy.

SlideTableKit() [3/3]

HPS::Publish::SlideTableKit::SlideTableKit

(

SlideTableKit &&

in_kit

)

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

Parameters

in_kit

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

~SlideTableKit()

virtual HPS::Publish::SlideTableKit::~SlideTableKit ( )

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::SlideTableKit::Empty ( ) const

virtual

Indicates whether this SlideTableKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Publish::SlideTableKit::Equals

(

SlideTableKit const &

in_kit

)

const

Check if the source SlideTableKit is equivalent to this SlideTableKit.

Parameters

in_kit

The source SlideTableKit to compare to this SlideTableKit.

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::SlideTableKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::SlideTableKit::operator!=

(

SlideTableKit const &

in_kit

)

const

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

Parameters

in_kit

The source SlideTableKit to compare to this SlideTableKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

SlideTableKit& HPS::Publish::SlideTableKit::operator=

(

SlideTableKit const &

in_kit

)

Copies the source SlideTableKit into this SlideTableKit.

Parameters

in_kit

The source SlideTableKit to copy.

Returns

A reference to this SlideTableKit.

operator=() [2/2]

SlideTableKit& HPS::Publish::SlideTableKit::operator=

(

SlideTableKit &&

in_kit

)

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

Parameters

in_kit

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

Returns

A reference to this SlideTableKit.

operator==()

bool HPS::Publish::SlideTableKit::operator==

(

SlideTableKit const &

in_kit

)

const

Check if the source SlideTableKit is equivalent to this SlideTableKit.

Parameters

in_kit

The source SlideTableKit to compare to this SlideTableKit.

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::SlideTableKit::Set

(

SlideTableKit const &

in_kit

)

Copies the source SlideTableKit into this SlideTableKit.

Parameters

in_kit

The source SlideTableKit to copy.

SetButtons()

SlideTableKit& HPS::Publish::SlideTableKit::SetButtons	(	char const *	in_previous_button_name,
		char const *	in_next_button_name
	)

Sets the button names for the slide table.

Parameters

in_previous_button_name	UTF8-encoded name for the previous button.
in_next_button_name	UTF8-encoded name for the next button.

Returns

A reference to this SlideTableKit.

SetHeader()

SlideTableKit& HPS::Publish::SlideTableKit::SetHeader

(

bool

in_state

)

Sets whether this slide table has a header.

Parameters

in_state

Whether this slide table has a header.

Returns

A reference to this SlideTableKit.

SetHTML()

SlideTableKit& HPS::Publish::SlideTableKit::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 SlideTableKit.

SetHTMLStyle()

SlideTableKit& HPS::Publish::SlideTableKit::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 SlideTableKit.

SetText() [1/2]

SlideTableKit& HPS::Publish::SlideTableKit::SetText	(	size_t	in_rows,
		size_t	in_columns,
		TextFieldKit const	in_text[]
	)

Sets the text strings for the slide table.

Parameters

in_rows	Number of rows.
in_columns	Number of columns.
in_text	Text strings for the slide table. This array should be of size in_rows * in_columns.

Returns

A reference to this SlideTableKit.

SetText() [2/2]

SlideTableKit& HPS::Publish::SlideTableKit::SetText	(	size_t	in_rows,
		size_t	in_columns,
		TextFieldKitArray const &	in_text
	)

Sets the text strings for the slide table.

Parameters

in_rows	Number of rows.
in_columns	Number of columns.
in_text	Text strings for the slide table. This array should be of size in_rows * in_columns.

Returns

A reference to this SlideTableKit.

Show()

void HPS::Publish::SlideTableKit::Show

(

SlideTableKit &

out_kit

)

const

Copies this SlideTableKit into the given SlideTableKit.

Parameters

out_kit

The SlideTableKit to populate with the contents of this SlideTableKit.

ShowButtons()

bool HPS::Publish::SlideTableKit::ShowButtons	(	UTF8 &	out_previous_button_name,
		UTF8 &	out_next_button_name
	)		const

Shows the buttons setting.

Parameters

out_previous_button_name	Name for the previous button.
out_next_button_name	Name for the next button.

Returns

true if button names were specified, false otherwise.

ShowHeader()

bool HPS::Publish::SlideTableKit::ShowHeader

(

bool &

out_state

)

const

Shows the header setting.

Parameters

out_state

Whether this slide table has a header.

Returns

true if a header setting was specified, false otherwise.

ShowHTML()

bool HPS::Publish::SlideTableKit::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::SlideTableKit::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.

ShowText()

bool HPS::Publish::SlideTableKit::ShowText	(	size_t &	out_rows,
		size_t &	out_columns,
		TextFieldKitArray &	out_text
	)		const

Shows the text strings setting.

Parameters

out_rows	Number of rows.
out_columns	Number of columns.
out_text	Text strings for the slide table.

Returns

true if text strings were specified, 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.

UnsetButtons()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetButtons

(

)

Removes the buttons setting.

Returns

A reference to this SlideTableKit.

UnsetEverything()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetEverything

(

)

Removes all data from the table.

Returns

A reference to this SlideTableKit.

UnsetHeader()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetHeader

(

)

Removes the header setting.

Returns

A reference to this SlideTableKit.

UnsetHTML()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetHTML

(

)

Removes the HTML table setting.

Returns

A reference to this SlideTableKit.

UnsetHTMLStyle()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetHTMLStyle

(

)

Removes the HTML table style setting.

Returns

A reference to this SlideTableKit.

UnsetText()

SlideTableKit& HPS::Publish::SlideTableKit::UnsetText

(

)

Removes the text strings setting.

Returns

A reference to this SlideTableKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::SlideTableKit::staticType = HPS::Type::PublishSlideTableKit

static

---

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

• sprk_publish.h