#include <sprk_publish.h>
|
static const HPS::Type | staticType = HPS::Type::PublishCheckBoxKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The CheckBoxKit class is a user space object. It acts as the container for all data that can be used to specify a check box for a Publish PDF.
◆ CheckBoxKit() [1/3]
HPS::Publish::CheckBoxKit::CheckBoxKit |
( |
| ) |
|
The default constructor creates an empty CheckBoxKit object.
◆ CheckBoxKit() [2/3]
HPS::Publish::CheckBoxKit::CheckBoxKit |
( |
CheckBoxKit const & |
in_kit | ) |
|
The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit.
- Parameters
-
◆ CheckBoxKit() [3/3]
HPS::Publish::CheckBoxKit::CheckBoxKit |
( |
CheckBoxKit && |
in_kit | ) |
|
The move constructor creates a CheckBoxKit by transferring the underlying object of the rvalue reference to this CheckBoxKit.
- Parameters
-
in_kit | An rvalue reference to a CheckBoxKit to take the underlying object from. |
◆ Empty()
bool HPS::Publish::CheckBoxKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Publish::CheckBoxKit::Equals |
( |
CheckBoxKit const & |
in_kit | ) |
const |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
static CheckBoxKit HPS::Publish::CheckBoxKit::GetDefault |
( |
| ) |
|
|
static |
Creates a CheckBoxKit 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 button unless a setting is overridden by the CheckBoxKit passed to a function.
- Returns
- A CheckBoxKit with the default settings.
◆ ObjectType()
HPS::Type HPS::Publish::CheckBoxKit::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::CheckBoxKit::operator!= |
( |
CheckBoxKit const & |
in_kit | ) |
const |
Check if the source CheckBoxKit is not equivalent to this CheckBoxKit.
- 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 CheckBoxKit.
- Parameters
-
in_kit | An rvalue reference to a CheckBoxKit to take the underlying object from. |
- Returns
- A reference to this CheckBoxKit.
◆ operator==()
bool HPS::Publish::CheckBoxKit::operator== |
( |
CheckBoxKit const & |
in_kit | ) |
const |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::CheckBoxKit::Set |
( |
CheckBoxKit const & |
in_kit | ) |
|
◆ SetBorder()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorder |
( |
bool |
in_state | ) |
|
Sets whether the check box has a border. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bHasBorder.
- Parameters
-
in_state | Whether the check box has a border. |
- Returns
- A reference to this CheckBoxKit.
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetDefaultState()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetDefaultState |
( |
bool |
in_state | ) |
|
◆ SetExportValue()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetExportValue |
( |
char const * |
in_export_value | ) |
|
Sets the export value used when field data is exported by Acrobat functions. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcExportValue.
- Parameters
-
in_export_value | UTF8-encoded export value of the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFillColor()
◆ SetFont() [1/2]
Sets a builtin font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
- Parameters
-
in_name | The builtin font for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFont() [2/2]
Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the check box. |
in_style | The style of font to use for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetFontSize()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetFontSize |
( |
int |
in_size | ) |
|
Sets the font size for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_iFontSize.
- Parameters
-
in_size | The font size for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetLock()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetLock |
( |
bool |
in_state | ) |
|
Sets whether the check box is locked. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsLocked.
- Parameters
-
in_state | Whether the check box is locked. |
- Returns
- A reference to this CheckBoxKit.
◆ SetName()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetName |
( |
char const * |
in_name | ) |
|
Sets the name of the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcName.
- Parameters
-
in_name | UTF8-encoded name of the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetPrintability()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetPrintability |
( |
bool |
in_state | ) |
|
Sets the printability for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.
- Parameters
-
in_state | The printability for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetTextColor()
Sets the text color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sTextColor.
- Parameters
-
in_color | The text color for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetTextRotation()
◆ SetTooltip()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetTooltip |
( |
char const * |
in_tooltip | ) |
|
Sets the tooltip for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcTooltip.
- Parameters
-
in_tooltip | UTF8-encoded tooltip text for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ SetVisibility()
CheckBoxKit& HPS::Publish::CheckBoxKit::SetVisibility |
( |
bool |
in_state | ) |
|
Sets the visibility for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.
- Parameters
-
in_state | The visibility for the check box. |
- Returns
- A reference to this CheckBoxKit.
◆ Show()
void HPS::Publish::CheckBoxKit::Show |
( |
CheckBoxKit & |
out_kit | ) |
const |
◆ ShowBorder()
bool HPS::Publish::CheckBoxKit::ShowBorder |
( |
bool & |
out_state | ) |
const |
Shows the border setting for the check box.
- Parameters
-
out_state | Whether the check box has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS::Publish::CheckBoxKit::ShowBorderColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the border color for the check box.
- Parameters
-
out_color | The border color of the check box. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
bool HPS::Publish::CheckBoxKit::ShowBorderStyle |
( |
Border::Style & |
out_style | ) |
const |
Shows the border style for the check box.
- Parameters
-
out_style | The border style for the check box. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
bool HPS::Publish::CheckBoxKit::ShowBorderThickness |
( |
Border::Thickness & |
out_thickness | ) |
const |
Shows the border thickness for the check box.
- Parameters
-
out_thickness | The border thickness for the check box. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowDefaultState()
bool HPS::Publish::CheckBoxKit::ShowDefaultState |
( |
bool & |
out_default_state | ) |
const |
Shows the default state for the check box.
- Parameters
-
out_default_state | The default state for the check box. |
- Returns
- true if a default state was specified, false otherwise.
◆ ShowExportValue()
bool HPS::Publish::CheckBoxKit::ShowExportValue |
( |
UTF8 & |
out_export_value | ) |
const |
Shows the export value for the check box.
- Parameters
-
out_export_value | The export value for the check box. |
- Returns
- true if an export value was specified, false otherwise.
◆ ShowFillColor()
bool HPS::Publish::CheckBoxKit::ShowFillColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the fill color for the check box.
- Parameters
-
out_color | The fill color for the check box. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the check box.
- Parameters
-
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
bool HPS::Publish::CheckBoxKit::ShowFontSize |
( |
int & |
out_size | ) |
const |
Shows the font size for the check box.
- Parameters
-
out_size | The font size for the check box. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowLock()
bool HPS::Publish::CheckBoxKit::ShowLock |
( |
bool & |
out_state | ) |
const |
Shows the lock setting for the check box.
- Parameters
-
in_state | Whether the check box is locked. |
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS::Publish::CheckBoxKit::ShowName |
( |
UTF8 & |
out_name | ) |
const |
Shows the name for the check box.
- Parameters
-
out_name | The name of the check box. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS::Publish::CheckBoxKit::ShowPrintability |
( |
bool & |
out_state | ) |
const |
Shows the printability for the check box.
- Parameters
-
out_state | The printability for the check box. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowTextColor()
bool HPS::Publish::CheckBoxKit::ShowTextColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the text color for the check box.
- Parameters
-
out_color | The text color for the check box. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
bool HPS::Publish::CheckBoxKit::ShowTextRotation |
( |
Text::Rotation & |
out_rotation | ) |
const |
Shows the text rotation for the check box.
- Parameters
-
out_rotation | The text rotation for the check box. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS::Publish::CheckBoxKit::ShowTooltip |
( |
UTF8 & |
out_tooltip | ) |
const |
Shows the tooltip for the check box.
- Parameters
-
out_tooltip | The tooltip text for the check box. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS::Publish::CheckBoxKit::ShowVisibility |
( |
bool & |
out_state | ) |
const |
Shows the visibility for the check box.
- Parameters
-
out_state | The visibility for the check box. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorder |
( |
| ) |
|
Removes the border setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderColor()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderColor |
( |
| ) |
|
Removes the border color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderStyle()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderStyle |
( |
| ) |
|
Removes the border style setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetBorderThickness()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderThickness |
( |
| ) |
|
Removes the border thickness setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetDefaultState()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetDefaultState |
( |
| ) |
|
Removes the default state setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetEverything()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetEverything |
( |
| ) |
|
Removes all data from the check box.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetExportValue()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetExportValue |
( |
| ) |
|
Removes the export value setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFillColor()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFillColor |
( |
| ) |
|
Removes the fill color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetFontSize()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFontSize |
( |
| ) |
|
Removes the font size setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetLock()
Removes the lock setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetName()
Removes the name setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetPrintability()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetPrintability |
( |
| ) |
|
Removes the printability setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTextColor()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextColor |
( |
| ) |
|
Removes the text color setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTextRotation()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextRotation |
( |
| ) |
|
Removes the text rotation setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetTooltip()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTooltip |
( |
| ) |
|
Removes the tooltip setting.
- Returns
- A reference to this CheckBoxKit.
◆ UnsetVisibility()
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetVisibility |
( |
| ) |
|
Removes the visibility setting.
- Returns
- A reference to this CheckBoxKit.
The documentation for this class was generated from the following file: