#include <sprk_publish.h>
|
|
static const HPS::Type | staticType = HPS::Type::PublishDataTableKit |
| |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
| |
| static const HPS::Type | staticType = HPS::Type::None |
| |
The DataTableKit class is a user space object. It acts as the container for all data that can be used to specify a Data Table for a Publish PDF.
◆ DataTableKit() [1/3]
| HPS::Publish::DataTableKit::DataTableKit |
( |
| ) |
|
The default constructor creates an empty DataTableKit object.
◆ DataTableKit() [2/3]
| HPS::Publish::DataTableKit::DataTableKit |
( |
DataTableKit const & |
in_kit | ) |
|
The copy constructor creates a new DataTableKit object that contains the same settings as the source DataTableKit.
- Parameters
-
◆ DataTableKit() [3/3]
| HPS::Publish::DataTableKit::DataTableKit |
( |
DataTableKit && |
in_kit | ) |
|
The move constructor creates a DataTableKit by transferring the underlying object of the rvalue reference to this DataTableKit.
- Parameters
-
| in_kit | An rvalue reference to a DataTableKit to take the underlying object from. |
◆ Empty()
| bool HPS::Publish::DataTableKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
| bool HPS::Publish::DataTableKit::Equals |
( |
DataTableKit const & |
in_kit | ) |
const |
Check if the source DataTableKit is equivalent to this DataTableKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
| static DataTableKit HPS::Publish::DataTableKit::GetDefault |
( |
| ) |
|
|
static |
Creates a DataTableKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for a text field unless a setting is overridden by the DataTableKit passed to a function.
- Returns
- A DataTableKit with the default settings.
◆ ObjectType()
| HPS::Type HPS::Publish::DataTableKit::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::DataTableKit::operator!= |
( |
DataTableKit const & |
in_kit | ) |
const |
Check if the source DataTableKit is not equivalent to this DataTableKit.
- 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 DataTableKit.
- Parameters
-
| in_kit | An rvalue reference to a DataTableKit to take the underlying object from. |
- Returns
- A reference to this DataTableKit.
◆ operator==()
| bool HPS::Publish::DataTableKit::operator== |
( |
DataTableKit const & |
in_kit | ) |
const |
Check if the source DataTableKit is equivalent to this DataTableKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
| void HPS::Publish::DataTableKit::Set |
( |
DataTableKit const & |
in_kit | ) |
|
◆ SetColumns()
| DataTableKit& HPS::Publish::DataTableKit::SetColumns |
( |
unsigned int |
in_value | ) |
|
Sets the number of columns for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_iNbCols.
- Parameters
-
| in_value | The number of columns of theData Table. |
- Returns
- A reference to this DataTableKit.
◆ SetData()
Sets the data for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_ppcTexts.
- Parameters
-
| in_value | The array of UTF8Array of data (string forms) to be put in the DataTable. |
- Returns
- A reference to this DataTableKit.
◆ SetRows()
| DataTableKit& HPS::Publish::DataTableKit::SetRows |
( |
unsigned int |
in_value | ) |
|
Sets the number of rows for the DataTable. This corresponds to the value that will be passed to 3DPDFDataTableData::m_iNbRows.
- Parameters
-
| in_value | The number of rows of theData Table. |
- Returns
- A reference to this DataTableKit.
◆ Show()
| void HPS::Publish::DataTableKit::Show |
( |
DataTableKit & |
out_kit | ) |
const |
◆ ShowColumns()
| bool HPS::Publish::DataTableKit::ShowColumns |
( |
unsigned int & |
out_number | ) |
const |
Shows the number of columns of the DataTable.
- Parameters
-
| out_number | The number of columns of the DataTable. |
- Returns
- true if a number of columns was specified, false otherwise.
◆ ShowData()
| bool HPS::Publish::DataTableKit::ShowData |
( |
UTF8ArrayArray & |
out_data | ) |
const |
Shows the data stored inside the DataTable.
- Parameters
-
| out_data | The data stored inside the DataTable. |
- Returns
- true if the DataTable contains any data, false otherwise.
◆ ShowRows()
| bool HPS::Publish::DataTableKit::ShowRows |
( |
unsigned int & |
out_number | ) |
const |
Shows the number of rows of the DataTable.
- Parameters
-
| out_number | The number of rows of the DataTable. |
- Returns
- true if a number of rows was specified, false otherwise.
◆ UnsetColumns()
Removes the columns setting.
- Returns
- A reference to this DataTableKit.
◆ UnsetData()
Removes the Data setting.
- Returns
- A reference to this DataTableKit.
◆ UnsetRows()
Removes the rows setting.
- Returns
- A reference to this DataTableKit.
The documentation for this class was generated from the following file:
Public Member Functions inherited from HPS::Sprocket