#include <sprk_publish.h>
|
bool | Empty () const |
|
bool | Equals (SlideTableKit const &in_kit) const |
|
HPS::Type | ObjectType () const |
|
bool | operator!= (SlideTableKit const &in_kit) const |
|
SlideTableKit & | operator= (SlideTableKit const &in_kit) |
|
SlideTableKit & | operator= (SlideTableKit &&in_kit) |
|
bool | operator== (SlideTableKit const &in_kit) const |
|
void | Set (SlideTableKit const &in_kit) |
|
SlideTableKit & | SetButtons (char const *in_previous_button_name, char const *in_next_button_name) |
|
SlideTableKit & | SetHeader (bool in_state) |
|
SlideTableKit & | SetHTML (char const *in_source, Source::Type in_type=Source::Type::Code) |
|
SlideTableKit & | SetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code) |
|
SlideTableKit & | SetText (size_t in_rows, size_t in_columns, TextFieldKit const in_text[]) |
|
SlideTableKit & | SetText (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) |
|
SlideTableKit & | UnsetButtons () |
|
SlideTableKit & | UnsetEverything () |
|
SlideTableKit & | UnsetHeader () |
|
SlideTableKit & | UnsetHTML () |
|
SlideTableKit & | UnsetHTMLStyle () |
|
SlideTableKit & | UnsetText () |
|
| Sprocket (Sprocket &&in_that) |
|
intptr_t | GetClassID () const |
|
intptr_t | GetInstanceID () const |
|
bool | HasType (HPS::Type in_mask) const |
|
| Object (Object const &that) |
|
| Object (Object &&in_that) |
|
Object & | operator= (Object const &other_object) |
|
Object & | operator= (Object &&in_that) |
|
virtual void | Reset () |
|
virtual HPS::Type | Type () const |
|
|
static const HPS::Type | staticType = HPS::Type::PublishSlideTableKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ SlideTableKit() [1/3]
HPS::Publish::SlideTableKit::SlideTableKit |
( |
| ) |
|
◆ SlideTableKit() [2/3]
HPS::Publish::SlideTableKit::SlideTableKit |
( |
SlideTableKit const & |
in_kit | ) |
|
◆ 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. |
◆ Empty()
bool HPS::Publish::SlideTableKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Publish::SlideTableKit::Equals |
( |
SlideTableKit const & |
in_kit | ) |
const |
Check if the source SlideTableKit is equivalent to this SlideTableKit.
- Parameters
-
- 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
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
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
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::SlideTableKit::Set |
( |
SlideTableKit const & |
in_kit | ) |
|
◆ 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()
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()
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]
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 |
◆ 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.
◆ UnsetButtons()
Removes the buttons setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetEverything()
Removes all data from the table.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHeader()
Removes the header setting.
- Returns
- A reference to this SlideTableKit.
◆ UnsetHTML()
◆ UnsetHTMLStyle()
◆ UnsetText()
Removes the text strings setting.
- Returns
- A reference to this SlideTableKit.
The documentation for this class was generated from the following file: