#include <sprk_publish.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (TableKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (TableKit const &in_kit) const |
TableKit & | operator= (TableKit const &in_kit) |
TableKit & | operator= (TableKit &&in_kit) |
bool | operator== (TableKit const &in_kit) const |
void | Set (TableKit const &in_kit) |
TableKit & | SetButton (int in_row, int in_column, ButtonKit const &in_button) |
TableKit & | SetHTML (char const *in_source, Source::Type in_type=Source::Type::Code) |
TableKit & | SetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code) |
TableKit & | SetLink (int in_row, int in_column, LinkKit const &in_link) |
TableKit & | SetText (int in_row, int in_column, TextKit const &in_text) |
TableKit & | SetTextField (int in_row, int in_column, TextFieldKit const &in_text_field) |
void | Show (TableKit &out_kit) const |
bool | ShowButton (int in_row, int in_column, ButtonKit &out_button) const |
bool | ShowHTML (UTF8 &out_source, Source::Type &out_type) const |
bool | ShowHTMLStyle (UTF8 &out_source, Source::Type &out_type) const |
bool | ShowLink (int in_row, int in_column, LinkKit &out_link) const |
bool | ShowText (int in_row, int in_column, TextKit &out_text) const |
bool | ShowTextField (int in_row, int in_column, TextFieldKit &out_text_field) const |
TableKit () | |
TableKit (TableKit const &in_kit) | |
TableKit (TableKit &&in_kit) | |
TableKit & | UnsetButton (int in_row, int in_column) |
TableKit & | UnsetEverything () |
TableKit & | UnsetHTML () |
TableKit & | UnsetHTMLStyle () |
TableKit & | UnsetLink (int in_row, int in_column) |
TableKit & | UnsetText (int in_row, int in_column) |
TableKit & | UnsetTextField (int in_row, int in_column) |
![]() | |
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 Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishTableKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
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
HPS::Publish::TableKit::TableKit | ( | ) |
The default constructor creates an empty TableKit object.
HPS::Publish::TableKit::TableKit | ( | TableKit const & | in_kit | ) |
HPS::Publish::TableKit::TableKit | ( | TableKit && | in_kit | ) |
Member Function Documentation
|
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.
bool HPS::Publish::TableKit::Equals | ( | TableKit const & | in_kit | ) | 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.
bool HPS::Publish::TableKit::operator!= | ( | TableKit const & | in_kit | ) | const |
bool HPS::Publish::TableKit::operator== | ( | TableKit const & | in_kit | ) | const |
void HPS::Publish::TableKit::Set | ( | TableKit const & | in_kit | ) |
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.
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.
TableKit& HPS::Publish::TableKit::SetHTMLStyle | ( | char const * | in_source, |
Source::Type | in_type = Source::Type::Code |
||
) |
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.
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.
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.
void HPS::Publish::TableKit::Show | ( | TableKit & | out_kit | ) | const |
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.
bool HPS::Publish::TableKit::ShowHTML | ( | UTF8 & | out_source, |
Source::Type & | out_type | ||
) | const |
bool HPS::Publish::TableKit::ShowHTMLStyle | ( | UTF8 & | out_source, |
Source::Type & | out_type | ||
) | const |
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.
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.
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.
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.
TableKit& HPS::Publish::TableKit::UnsetEverything | ( | ) |
Removes all data from the table.
- Returns
- A reference to this TableKit.
TableKit& HPS::Publish::TableKit::UnsetHTML | ( | ) |
TableKit& HPS::Publish::TableKit::UnsetHTMLStyle | ( | ) |
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.
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.
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.
The documentation for this class was generated from the following file:
- include/sprk_publish.h