HPS::Publish::SlideTableKit

class HPS::Publish::SlideTableKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this SlideTableKit has any values set on it.

Returns

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

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

inline virtual HPS::Type ObjectType() const

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.

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

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.

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.

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

void Set(SlideTableKit const &in_kit)

Copies the source SlideTableKit into this SlideTableKit.

Parameters

in_kit – The source SlideTableKit to copy.

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

SlideTableKit()

The default constructor creates an empty SlideTableKit object.

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

Removes the buttons setting.

Returns

A reference to this SlideTableKit.

SlideTableKit &UnsetEverything()

Removes all data from the table.

Returns

A reference to this SlideTableKit.

SlideTableKit &UnsetHeader()

Removes the header setting.

Returns

A reference to this SlideTableKit.

SlideTableKit &UnsetHTML()

Removes the HTML table setting.

Returns

A reference to this SlideTableKit.

SlideTableKit &UnsetHTMLStyle()

Removes the HTML table style setting.

Returns

A reference to this SlideTableKit.

SlideTableKit &UnsetText()

Removes the text strings setting.

Returns

A reference to this SlideTableKit.