#include <sprk_publish.h>
Static Public Member Functions | |
static CheckBoxKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
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.
HPS::Publish::CheckBoxKit::CheckBoxKit | ( | ) |
The default constructor creates an empty CheckBoxKit object.
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.
in_kit | The source CheckBoxKit to copy. |
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.
in_kit | An rvalue reference to a CheckBoxKit to take the underlying object from. |
|
virtual |
Indicates whether this CheckBoxKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::CheckBoxKit::Equals | ( | CheckBoxKit const & | in_kit | ) | const |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
in_kit | The source CheckBoxKit to compare to this CheckBoxKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::Publish::CheckBoxKit::operator!= | ( | CheckBoxKit const & | in_kit | ) | const |
Check if the source CheckBoxKit is not equivalent to this CheckBoxKit.
in_kit | The source CheckBoxKit to compare to this CheckBoxKit. |
CheckBoxKit& HPS::Publish::CheckBoxKit::operator= | ( | CheckBoxKit const & | in_kit | ) |
Copies the source CheckBoxKit into this CheckBoxKit.
in_kit | The source CheckBoxKit to copy. |
CheckBoxKit& HPS::Publish::CheckBoxKit::operator= | ( | CheckBoxKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this CheckBoxKit.
in_kit | An rvalue reference to a CheckBoxKit to take the underlying object from. |
bool HPS::Publish::CheckBoxKit::operator== | ( | CheckBoxKit const & | in_kit | ) | const |
Check if the source CheckBoxKit is equivalent to this CheckBoxKit.
in_kit | The source CheckBoxKit to compare to this CheckBoxKit. |
void HPS::Publish::CheckBoxKit::Set | ( | CheckBoxKit const & | in_kit | ) |
Copies the source CheckBoxKit into this CheckBoxKit.
in_kit | The source CheckBoxKit to copy. |
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.
in_state | Whether the check box has a border. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorderColor | ( | RGBColor const & | in_color | ) |
Sets the border color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sBorderColor.
in_color | The border color of the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorderStyle | ( | Border::Style | in_style | ) |
Sets the border style for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eLineStyleBorder.
in_style | The border style for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorderThickness | ( | Border::Thickness | in_thickness | ) |
Sets the border thickness for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eThicknessBorder.
in_thickness | The border thickness for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetDefaultState | ( | bool | in_state | ) |
Sets whether the check box is checked by default. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsCheckedByDefault.
in_state | Whether the check box is checked by default. |
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.
in_export_value | UTF8-encoded export value of the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetFillColor | ( | RGBColor const & | in_color | ) |
Sets the fill color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sFillColor and implicitly sets A3DPDFCheckBoxData::m_bHasFillColor to true.
in_color | The fill color for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetFont | ( | Text::Font::Name | in_name | ) |
Sets a builtin font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
in_name | The builtin font for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetFont | ( | char const * | in_name, |
Text::Font::Style | in_style = Text::Font::Style::Regular |
||
) |
Sets a specific font for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.
in_name | UTF8-encoded font name for the check box. |
in_style | The style of font to use for the check box. |
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.
in_size | The font size for the check box. |
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.
in_state | Whether the check box is locked. |
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.
in_name | UTF8-encoded name of the check box. |
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.
in_state | The printability for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetTextColor | ( | RGBColor const & | in_color | ) |
Sets the text color for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sTextColor.
in_color | The text color for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::SetTextRotation | ( | Text::Rotation | in_rotation | ) |
Sets the text rotation for the check box. This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eTextOrientation.
in_rotation | The text rotation for the check box. |
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.
in_tooltip | UTF8-encoded tooltip text for the check box. |
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.
in_state | The visibility for the check box. |
void HPS::Publish::CheckBoxKit::Show | ( | CheckBoxKit & | out_kit | ) | const |
Copies this CheckBoxKit into the given CheckBoxKit.
out_kit | The CheckBoxKit to populate with the contents of this CheckBoxKit. |
bool HPS::Publish::CheckBoxKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the check box.
out_state | Whether the check box has a border. |
bool HPS::Publish::CheckBoxKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the check box.
out_color | The border color of the check box. |
bool HPS::Publish::CheckBoxKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the check box.
out_style | The border style for the check box. |
bool HPS::Publish::CheckBoxKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the check box.
out_thickness | The border thickness for the check box. |
bool HPS::Publish::CheckBoxKit::ShowDefaultState | ( | bool & | out_default_state | ) | const |
Shows the default state for the check box.
out_default_state | The default state for the check box. |
bool HPS::Publish::CheckBoxKit::ShowExportValue | ( | UTF8 & | out_export_value | ) | const |
Shows the export value for the check box.
out_export_value | The export value for the check box. |
bool HPS::Publish::CheckBoxKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the check box.
out_color | The fill color for the check box. |
bool HPS::Publish::CheckBoxKit::ShowFont | ( | Text::Font::Type & | out_type, |
Text::Font::Name & | out_name, | ||
UTF8 & | out_font_name, | ||
Text::Font::Style & | out_style | ||
) | const |
Shows the font for the check box.
out_type | The type of font for the check box. |
out_font | The built-in font for the check box. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the check box. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the check box. This is only valid if out_type is Text::Font::Type::Explicit. |
bool HPS::Publish::CheckBoxKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the check box.
out_size | The font size for the check box. |
bool HPS::Publish::CheckBoxKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the check box.
in_state | Whether the check box is locked. |
bool HPS::Publish::CheckBoxKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the check box.
out_name | The name of the check box. |
bool HPS::Publish::CheckBoxKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the check box.
out_state | The printability for the check box. |
bool HPS::Publish::CheckBoxKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the check box.
out_color | The text color for the check box. |
bool HPS::Publish::CheckBoxKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the check box.
out_rotation | The text rotation for the check box. |
bool HPS::Publish::CheckBoxKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the check box.
out_tooltip | The tooltip text for the check box. |
bool HPS::Publish::CheckBoxKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the check box.
out_state | The visibility for the check box. |
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorder | ( | ) |
Removes the border setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetDefaultState | ( | ) |
Removes the default state setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetEverything | ( | ) |
Removes all data from the check box.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetExportValue | ( | ) |
Removes the export value setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFont | ( | ) |
Removes the font setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFontSize | ( | ) |
Removes the font size setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetLock | ( | ) |
Removes the lock setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetName | ( | ) |
Removes the name setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetPrintability | ( | ) |
Removes the printability setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextColor | ( | ) |
Removes the text color setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetVisibility | ( | ) |
Removes the visibility setting.