HPS::Publish::SlideTableKit Class Reference

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::SlideTableKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (SlideTableKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (SlideTableKit const &in_kit) const
 
SlideTableKitoperator= (SlideTableKit const &in_kit)
 
SlideTableKitoperator= (SlideTableKit &&in_kit)
 
bool operator== (SlideTableKit const &in_kit) const
 
void Set (SlideTableKit const &in_kit)
 
SlideTableKitSetButtons (char const *in_previous_button_name, char const *in_next_button_name)
 
SlideTableKitSetHeader (bool in_state)
 
SlideTableKitSetHTML (char const *in_source, Source::Type in_type=Source::Type::Code)
 
SlideTableKitSetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code)
 
SlideTableKitSetText (size_t in_rows, size_t in_columns, TextFieldKit const in_text[])
 
SlideTableKitSetText (size_t in_rows, size_t in_columns, TextFieldKitArray const &in_text)
 
void Show (SlideTableKit &out_kit) const
 
bool ShowButtons (UTF8 &out_previous_button_name, UTF8 &out_next_button_name) const
 
bool ShowHeader (bool &out_state) const
 
bool ShowHTML (UTF8 &out_source, Source::Type &out_type) const
 
bool ShowHTMLStyle (UTF8 &out_source, Source::Type &out_type) const
 
bool ShowText (size_t &out_rows, size_t &out_columns, TextFieldKitArray &out_text) const
 
 SlideTableKit ()
 
 SlideTableKit (SlideTableKit const &in_kit)
 
 SlideTableKit (SlideTableKit &&in_kit)
 
SlideTableKitUnsetButtons ()
 
SlideTableKitUnsetEverything ()
 
SlideTableKitUnsetHeader ()
 
SlideTableKitUnsetHTML ()
 
SlideTableKitUnsetHTMLStyle ()
 
SlideTableKitUnsetText ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishSlideTableKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

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_kitThe 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_kitAn rvalue reference to a SlideTableKit to take the underlying object from.

Member Function Documentation

◆ 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_kitThe source SlideTableKit to compare to this SlideTableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::Publish::SlideTableKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Publish::SlideTableKit::operator!= ( SlideTableKit const &  in_kit) const

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

Parameters
in_kitThe 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_kitThe 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_kitAn 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_kitThe source SlideTableKit to compare to this SlideTableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::SlideTableKit::Set ( SlideTableKit const &  in_kit)

Copies the source SlideTableKit into this SlideTableKit.

Parameters
in_kitThe 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_nameUTF8-encoded name for the previous button.
in_next_button_nameUTF8-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_stateWhether 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_sourceUTF8-encoded HTML table source or file (depending on the following argument).
in_typeThe 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_sourceUTF8-encoded HTML table style source or file (depending on the following argument).
in_typeType 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_rowsNumber of rows.
in_columnsNumber of columns.
in_textText 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_rowsNumber of rows.
in_columnsNumber of columns.
in_textText 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_kitThe 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_nameName for the previous button.
out_next_button_nameName 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_stateWhether 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_sourceThe HTML table source or file (depending on the following argument).
out_typeThe 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_sourceThe HTML table style source or file (depending on the following argument).
out_typeThe 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_rowsNumber of rows.
out_columnsNumber of columns.
out_textText strings for the slide table.
Returns
true if text strings were specified, false otherwise.

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

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