#include <sprk_publish.h>

Static Public Member Functions | |
static ButtonKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishButtonKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The ButtonKit class is a user space object. It acts as the container for all data that can be used to specify a button for a Publish PDF.
Constructor & Destructor Documentation
HPS::Publish::ButtonKit::ButtonKit | ( | ) |
The default constructor creates an empty ButtonKit object.
HPS::Publish::ButtonKit::ButtonKit | ( | ButtonKit const & | in_kit | ) |
HPS::Publish::ButtonKit::ButtonKit | ( | ButtonKit && | in_kit | ) |
Member Function Documentation
|
virtual |
Indicates whether this ButtonKit has any values set on it.
- Returns
- true if no values are set on this ButtonKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Publish::ButtonKit::Equals | ( | ButtonKit const & | in_kit | ) | const |
|
static |
Creates a ButtonKit 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 ButtonKit passed to a function.
- Returns
- A ButtonKit with the default settings.
bool HPS::Publish::ButtonKit::operator!= | ( | ButtonKit const & | in_kit | ) | const |
bool HPS::Publish::ButtonKit::operator== | ( | ButtonKit const & | in_kit | ) | const |
void HPS::Publish::ButtonKit::Set | ( | ButtonKit const & | in_kit | ) |
ButtonKit& HPS::Publish::ButtonKit::SetBorder | ( | bool | in_state | ) |
Sets whether the button has a border. This corresponds to the value that will be passed to A3DPDFButtonData::m_bHasBorder.
- Parameters
-
in_state Whether the button has a border.
- Returns
- A reference to this ButtonKit.
Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.
- Parameters
-
in_color The border color of the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetBorderStyle | ( | Border::Style | in_style | ) |
Sets the border style for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLineStyleBorder.
- Parameters
-
in_style The border style for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetBorderThickness | ( | Border::Thickness | in_thickness | ) |
Sets the border thickness for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eThicknessBorder.
- Parameters
-
in_thickness The border thickness for the button.
- Returns
- A reference to this ButtonKit.
Sets the fill color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sFillColor and implicitly sets A3DPDFButtonData::m_bHasFillColor to true.
- Parameters
-
in_color The fill color for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetFont | ( | Text::Font::Name | in_name | ) |
Sets a builtin font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name The builtin font for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetFont | ( | char const * | in_name, |
Text::Font::Style | in_style = Text::Font::Style::Regular |
||
) |
Sets a specific font for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcFontName.
- Parameters
-
in_name UTF8-encoded font name for the button. in_style The style of font to use for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetFontSize | ( | int | in_size | ) |
Sets the font size for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_iFontSize.
- Parameters
-
in_size The font size for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetHighlighting | ( | Highlighting::Mode | in_mode | ) |
Sets the highlighting mode for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eHighlightingMode.
- Parameters
-
in_mode The highlighting mode for the button.
- Returns
- A reference to this ButtonKit.
Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.
- Parameters
-
in_image The icon image for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetLabel | ( | char const * | in_label | ) |
Sets the label for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcLabel.
- Parameters
-
in_label UTF8-encoded label for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetLabelPosition | ( | Label::Position | in_position | ) |
Sets the label position for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eLayoutTextIcon.
- Parameters
-
in_position The label position for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetLock | ( | bool | in_state | ) |
Sets whether the button is locked. This corresponds to the value that will be passed to A3DPDFButtonData::m_bIsLocked.
- Parameters
-
in_state Whether the button is locked.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetName | ( | char const * | in_name | ) |
Sets the name of the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcName.
- Parameters
-
in_name UTF8-encoded name of the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetPrintability | ( | bool | in_state | ) |
Sets the printability for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state The printability for the button.
- Returns
- A reference to this ButtonKit.
Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.
- Parameters
-
in_color The text color for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetTextRotation | ( | Text::Rotation | in_rotation | ) |
Sets the text rotation for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eTextOrientation.
- Parameters
-
in_rotation The text rotation for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetTooltip | ( | char const * | in_tooltip | ) |
Sets the tooltip for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pcTooltip.
- Parameters
-
in_tooltip UTF8-encoded tooltip text for the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::SetVisibility | ( | bool | in_state | ) |
Sets the visibility for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_eFormField.
- Parameters
-
in_state The visibility for the button.
- Returns
- A reference to this ButtonKit.
void HPS::Publish::ButtonKit::Show | ( | ButtonKit & | out_kit | ) | const |
bool HPS::Publish::ButtonKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the button.
- Parameters
-
out_state Whether the button has a border.
- Returns
- true if a border setting was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the button.
- Parameters
-
out_color The border color of the button.
- Returns
- true if a border color was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the button.
- Parameters
-
out_style The border style for the button.
- Returns
- true if a border style was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the button.
- Parameters
-
out_thickness The border thickness for the button.
- Returns
- true if a border thickness was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the button.
- Parameters
-
out_color The fill color for the button.
- Returns
- true if a fill color was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowFont | ( | Text::Font::Type & | out_type, |
Text::Font::Name & | out_font, | ||
UTF8 & | out_font_name, | ||
Text::Font::Style & | out_style | ||
) | const |
Shows the font for the button.
- Parameters
-
out_type The type of font for the button. out_font The built-in font for the button. This is only valid if out_type is Text::Font::Type::BuiltIn. out_font_name The explicit font name for the button. This is only valid if out_type is Text::Font::Type::Explicit. out_style The font style for the button. This is only valid if out_type is Text::Font::Type::Explicit.
- Returns
- true if a font was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the button.
- Parameters
-
out_size The font size for the button.
- Returns
- true if a font size was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowHighlighting | ( | Highlighting::Mode & | out_mode | ) | const |
Shows the highlighting mode for the button.
- Parameters
-
out_mode The highlighting mode for the button.
- Returns
- true if a highlighting mode was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowIconImage | ( | ImageKit & | out_image | ) | const |
Shows the icon image for the button.
- Parameters
-
out_image The icon image for the button.
- Returns
- true if an icon image was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowLabel | ( | UTF8 & | out_label | ) | const |
Shows the label for the button.
- Parameters
-
out_label The label for the button.
- Returns
- true if a label was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowLabelPosition | ( | Label::Position & | out_position | ) | const |
Shows the label position for the button.
- Parameters
-
out_position The label position for the button.
- Returns
- true if a label position was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the button.
- Parameters
-
in_state Whether the button is locked.
- Returns
- true if a lock setting was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the button.
- Parameters
-
out_name The name of the button.
- Returns
- true if a name was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the button.
- Parameters
-
out_state The printability for the button.
- Returns
- true if a printability was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the button.
- Parameters
-
out_color The text color for the button.
- Returns
- true if a text color was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the button.
- Parameters
-
out_rotation The text rotation for the button.r
- Returns
- true if a rotation was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the button.
- Parameters
-
out_tooltip The tooltip text for the button.
- Returns
- true if a tooltip was specified, false otherwise.
bool HPS::Publish::ButtonKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the button.
- Parameters
-
out_state The visibility for the button.
- Returns
- true if a visibility was specified, false otherwise.
ButtonKit& HPS::Publish::ButtonKit::UnsetBorder | ( | ) |
Removes the border setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetEverything | ( | ) |
Removes all data from the button.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetFont | ( | ) |
Removes the font setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetFontSize | ( | ) |
Removes the font size setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetHighlighting | ( | ) |
Removes the highlighting mode setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetIconImage | ( | ) |
Removes the icon image setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetLabel | ( | ) |
Removes the label setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetLabelPosition | ( | ) |
Removes the label position setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetLock | ( | ) |
Removes the lock setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetName | ( | ) |
Removes the name setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetPrintability | ( | ) |
Removes the printability setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetTextColor | ( | ) |
Removes the text color setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
- Returns
- A reference to this ButtonKit.
ButtonKit& HPS::Publish::ButtonKit::UnsetVisibility | ( | ) |
Removes the visibility setting.
- Returns
- A reference to this ButtonKit.
The documentation for this class was generated from the following file:
- include/sprk_publish.h