HPS::Publish::TableKit Class Reference

#include <sprk_publish.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (TableKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (TableKit const &in_kit) const
 
TableKitoperator= (TableKit const &in_kit)
 
TableKitoperator= (TableKit &&in_kit)
 
bool operator== (TableKit const &in_kit) const
 
void Set (TableKit const &in_kit)
 
TableKitSetButton (int in_row, int in_column, ButtonKit const &in_button)
 
TableKitSetHTML (char const *in_source, Source::Type in_type=Source::Type::Code)
 
TableKitSetHTMLStyle (char const *in_source, Source::Type in_type=Source::Type::Code)
 
TableKitSetLink (int in_row, int in_column, LinkKit const &in_link)
 
TableKitSetText (int in_row, int in_column, TextKit const &in_text)
 
TableKitSetTextField (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)
 
TableKitUnsetButton (int in_row, int in_column)
 
TableKitUnsetEverything ()
 
TableKitUnsetHTML ()
 
TableKitUnsetHTMLStyle ()
 
TableKitUnsetLink (int in_row, int in_column)
 
TableKitUnsetText (int in_row, int in_column)
 
TableKitUnsetTextField (int in_row, int in_column)
 
- 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::PublishTableKit
 
- 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 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

◆ TableKit() [1/3]

HPS::Publish::TableKit::TableKit ( )

The default constructor creates an empty TableKit object.

◆ TableKit() [2/3]

HPS::Publish::TableKit::TableKit ( TableKit const &  in_kit)

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

Parameters
in_kitThe source TableKit to copy.

◆ TableKit() [3/3]

HPS::Publish::TableKit::TableKit ( TableKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a TableKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Publish::TableKit::Empty ( ) const
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.

◆ Equals()

bool HPS::Publish::TableKit::Equals ( TableKit const &  in_kit) const

Check if the source TableKit is equivalent to this TableKit.

Parameters
in_kitThe source TableKit to compare to this TableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::Publish::TableKit::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::TableKit::operator!= ( TableKit const &  in_kit) const

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

Parameters
in_kitThe source TableKit to compare to this TableKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TableKit& HPS::Publish::TableKit::operator= ( TableKit const &  in_kit)

Copies the source TableKit into this TableKit.

Parameters
in_kitThe source TableKit to copy.
Returns
A reference to this TableKit.

◆ operator=() [2/2]

TableKit& HPS::Publish::TableKit::operator= ( TableKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a TableKit to take the underlying object from.
Returns
A reference to this TableKit.

◆ operator==()

bool HPS::Publish::TableKit::operator== ( TableKit const &  in_kit) const

Check if the source TableKit is equivalent to this TableKit.

Parameters
in_kitThe source TableKit to compare to this TableKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source TableKit into this TableKit.

Parameters
in_kitThe source TableKit to copy.

◆ SetButton()

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_rowRow in which to add the button.
in_columnColumn in which to add the button.
in_buttonButton to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetHTML()

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_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 TableKit.

◆ SetHTMLStyle()

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

◆ SetLink()

TableKit& HPS::Publish::TableKit::SetLink ( int  in_row,
int  in_column,
LinkKit const &  in_link 
)

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_rowRow in which to add the link.
in_columnColumn in which to add the link.
in_linkLink to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetText()

TableKit& HPS::Publish::TableKit::SetText ( int  in_row,
int  in_column,
TextKit const &  in_text 
)

Adds text to this table at the specified row and column. This corresponds to the value that will be passed to A3DPDFPageInsertTextInTable.

Parameters
in_rowRow in which to add the text.
in_columnColumn in which to add the text.
in_textText to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ SetTextField()

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_rowRow in which to add the text field.
in_columnColumn in which to add the text field.
in_text_fieldText field to add at the specified row and column in the table.
Returns
A reference to this TableKit.

◆ Show()

void HPS::Publish::TableKit::Show ( TableKit out_kit) const

Copies this TableKit into the given TableKit.

Parameters
out_kitThe TableKit to populate with the contents of this TableKit.

◆ ShowButton()

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_rowRow in which to show the button.
in_columnColumn in which to show the button.
out_buttonThe 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.

◆ ShowHTML()

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

◆ ShowLink()

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_rowRow in which to show the link.
in_columnColumn in which to show the link.
out_linkThe 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.

◆ ShowText()

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_rowRow in which to show the text.
in_columnColumn in which to show the text.
out_textThe text at the specified row and column in the table.
Returns
true if text was added at the specified row and column, false otherwise.

◆ ShowTextField()

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_rowRow in which to show the link.
in_columnColumn in which to show the link.
out_text_fieldThe 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.

◆ UnsetButton()

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.

◆ UnsetEverything()

TableKit& HPS::Publish::TableKit::UnsetEverything ( )

Removes all data from the table.

Returns
A reference to this TableKit.

◆ UnsetHTML()

TableKit& HPS::Publish::TableKit::UnsetHTML ( )

Removes the HTML table setting.

Returns
A reference to this TableKit.

◆ UnsetHTMLStyle()

TableKit& HPS::Publish::TableKit::UnsetHTMLStyle ( )

Removes the HTML table style setting.

Returns
A reference to this TableKit.

◆ UnsetLink()

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.

◆ UnsetText()

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.

◆ UnsetTextField()

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: