REFERENCE MANUAL
#include <sprk_publish.h>
Static Public Member Functions | |
static ButtonKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
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.
Publish::ButtonKit::ButtonKit | ( | ) |
The default constructor creates an empty ButtonKit object.
Publish::ButtonKit::ButtonKit | ( | ButtonKit const & | in_kit | ) |
Publish::ButtonKit::ButtonKit | ( | ButtonKit && | in_kit | ) |
|
virtual |
bool 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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Publish::ButtonKit::operator!= | ( | ButtonKit const & | in_kit | ) | const |
bool Publish::ButtonKit::operator== | ( | ButtonKit const & | in_kit | ) | const |
void Publish::ButtonKit::Set | ( | ButtonKit const & | in_kit | ) |
ButtonKit& 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.
in_state | Whether the button has a border. |
Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.
in_color | The border color of the button. |
ButtonKit& 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.
in_style | The border style for the button. |
ButtonKit& 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.
in_thickness | The border thickness for the button. |
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.
in_color | The fill color for the button. |
ButtonKit& 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.
in_name | The builtin font for the button. |
ButtonKit& 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.
in_name | UTF8-encoded font name for the button. |
in_style | The style of font to use for the button. |
ButtonKit& 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.
in_size | The font size for the button. |
ButtonKit& 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.
in_mode | The highlighting mode for the button. |
Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.
in_image | The icon image for the button. |
ButtonKit& 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.
in_label | UTF8-encoded label for the button. |
ButtonKit& 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.
in_position | The label position for the button. |
ButtonKit& 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.
in_state | Whether the button is locked. |
ButtonKit& 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.
in_name | UTF8-encoded name of the button. |
ButtonKit& 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.
in_state | The printability for the button. |
Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.
in_color | The text color for the button. |
ButtonKit& 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.
in_rotation | The text rotation for the button. |
ButtonKit& 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.
in_tooltip | UTF8-encoded tooltip text for the button. |
ButtonKit& 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.
in_state | The visibility for the button. |
void Publish::ButtonKit::Show | ( | ButtonKit & | out_kit | ) | const |
bool Publish::ButtonKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the button.
out_state | Whether the button has a border. |
bool Publish::ButtonKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the button.
out_color | The border color of the button. |
bool Publish::ButtonKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the button.
out_style | The border style for the button. |
bool Publish::ButtonKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the button.
out_thickness | The border thickness for the button. |
bool Publish::ButtonKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the button.
out_color | The fill color for the button. |
bool Publish::ButtonKit::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 button.
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. |
bool Publish::ButtonKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the button.
out_size | The font size for the button. |
bool Publish::ButtonKit::ShowHighlighting | ( | Highlighting::Mode & | out_mode | ) | const |
Shows the highlighting mode for the button.
out_mode | The highlighting mode for the button. |
bool Publish::ButtonKit::ShowIconImage | ( | ImageKit & | out_image | ) | const |
Shows the icon image for the button.
out_image | The icon image for the button. |
bool Publish::ButtonKit::ShowLabel | ( | UTF8 & | out_label | ) | const |
Shows the label for the button.
out_label | The label for the button. |
bool Publish::ButtonKit::ShowLabelPosition | ( | Label::Position & | out_position | ) | const |
Shows the label position for the button.
out_position | The label position for the button. |
bool Publish::ButtonKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the button.
in_state | Whether the button is locked. |
bool Publish::ButtonKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the button.
out_name | The name of the button. |
bool Publish::ButtonKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the button.
out_state | The printability for the button. |
bool Publish::ButtonKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the button.
out_color | The text color for the button. |
bool Publish::ButtonKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the button.
out_rotation | The text rotation for the button.r |
bool Publish::ButtonKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the button.
out_tooltip | The tooltip text for the button. |
bool Publish::ButtonKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the button.
out_state | The visibility for the button. |
ButtonKit& Publish::ButtonKit::UnsetBorder | ( | ) |
Removes the border setting.
ButtonKit& Publish::ButtonKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
ButtonKit& Publish::ButtonKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
ButtonKit& Publish::ButtonKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
ButtonKit& Publish::ButtonKit::UnsetEverything | ( | ) |
Removes all data from the button.
ButtonKit& Publish::ButtonKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
ButtonKit& Publish::ButtonKit::UnsetFont | ( | ) |
Removes the font setting.
ButtonKit& Publish::ButtonKit::UnsetFontSize | ( | ) |
Removes the font size setting.
ButtonKit& Publish::ButtonKit::UnsetHighlighting | ( | ) |
Removes the highlighting mode setting.
ButtonKit& Publish::ButtonKit::UnsetIconImage | ( | ) |
Removes the icon image setting.
ButtonKit& Publish::ButtonKit::UnsetLabel | ( | ) |
Removes the label setting.
ButtonKit& Publish::ButtonKit::UnsetLabelPosition | ( | ) |
Removes the label position setting.
ButtonKit& Publish::ButtonKit::UnsetLock | ( | ) |
Removes the lock setting.
ButtonKit& Publish::ButtonKit::UnsetName | ( | ) |
Removes the name setting.
ButtonKit& Publish::ButtonKit::UnsetPrintability | ( | ) |
Removes the printability setting.
ButtonKit& Publish::ButtonKit::UnsetTextColor | ( | ) |
Removes the text color setting.
ButtonKit& Publish::ButtonKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
ButtonKit& Publish::ButtonKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
ButtonKit& Publish::ButtonKit::UnsetVisibility | ( | ) |
Removes the visibility setting.