#include <sprk_publish.h>
Static Public Member Functions | |
static RadioButtonKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The RadioButtonKit class is a user space object. It acts as the container for all data that can be used to specify a radio button for a Publish PDF.
HPS::Publish::RadioButtonKit::RadioButtonKit | ( | ) |
The default constructor creates an empty RadioButtonKit object.
HPS::Publish::RadioButtonKit::RadioButtonKit | ( | RadioButtonKit const & | in_kit | ) |
The copy constructor creates a new RadioButtonKit object that contains the same settings as the source RadioButtonKit.
in_kit | The source RadioButtonKit to copy. |
HPS::Publish::RadioButtonKit::RadioButtonKit | ( | RadioButtonKit && | in_kit | ) |
The move constructor creates a RadioButtonKit by transferring the underlying object of the rvalue reference to this RadioButtonKit.
in_kit | An rvalue reference to a RadioButtonKit to take the underlying object from. |
|
virtual |
Indicates whether this RadioButtonKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::RadioButtonKit::Equals | ( | RadioButtonKit const & | in_kit | ) | const |
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
in_kit | The source RadioButtonKit to compare to this RadioButtonKit. |
|
static |
Creates a RadioButtonKit 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 RadioButtonKit 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::RadioButtonKit::operator!= | ( | RadioButtonKit const & | in_kit | ) | const |
Check if the source RadioButtonKit is not equivalent to this RadioButtonKit.
in_kit | The source RadioButtonKit to compare to this RadioButtonKit. |
RadioButtonKit& HPS::Publish::RadioButtonKit::operator= | ( | RadioButtonKit const & | in_kit | ) |
Copies the source RadioButtonKit into this RadioButtonKit.
in_kit | The source RadioButtonKit to copy. |
RadioButtonKit& HPS::Publish::RadioButtonKit::operator= | ( | RadioButtonKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this RadioButtonKit.
in_kit | An rvalue reference to a RadioButtonKit to take the underlying object from. |
bool HPS::Publish::RadioButtonKit::operator== | ( | RadioButtonKit const & | in_kit | ) | const |
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
in_kit | The source RadioButtonKit to compare to this RadioButtonKit. |
void HPS::Publish::RadioButtonKit::Set | ( | RadioButtonKit const & | in_kit | ) |
Copies the source RadioButtonKit into this RadioButtonKit.
in_kit | The source RadioButtonKit to copy. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetBorder | ( | bool | in_state | ) |
Sets whether the radio button has a border. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bHasBorder.
in_state | Whether the radio button has a border. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetBorderColor | ( | RGBColor const & | in_color | ) |
Sets the border color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sBorderColor.
in_color | The border color of the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetBorderStyle | ( | Border::Style | in_style | ) |
Sets the border style for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eLineStyleBorder.
in_style | The border style for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetBorderThickness | ( | Border::Thickness | in_thickness | ) |
Sets the border thickness for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eThicknessBorder.
in_thickness | The border thickness for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetDefaultState | ( | bool | in_state | ) |
Sets whether the radio button is checked by default. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsCheckedByDefault.
in_state | Whether the radio button is checked by default. |
RadioButtonKit& HPS::Publish::RadioButtonKit::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 A3DPDFRadioButtonData::m_pcExportValue.
in_export_value | UTF8-encoded export value of the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetFillColor | ( | RGBColor const & | in_color | ) |
Sets the fill color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sFillColor and implicitly sets A3DPDFRadioButtonData::m_bHasFillColor to true.
in_color | The fill color for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetFont | ( | Text::Font::Name | in_name | ) |
Sets a builtin font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.
in_name | The builtin font for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetFont | ( | char const * | in_name, |
Text::Font::Style | in_style = Text::Font::Style::Regular |
||
) |
Sets a specific font for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcFontName.
in_name | UTF8-encoded font name for the radio button. |
in_style | The style of font to use for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetFontSize | ( | int | in_size | ) |
Sets the font size for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_iFontSize.
in_size | The font size for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetGrouping | ( | bool | in_state | ) |
Sets whether the radio buttons with the same names are grouped, and therefore mutually exclusive. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bRadiosInUnison.
in_state | Whether the radio button is part of a group. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetLock | ( | bool | in_state | ) |
Sets whether the radio button is locked. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_bIsLocked.
in_state | Whether the radio button is locked. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetName | ( | char const * | in_name | ) |
Sets the name of the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcName.
in_name | UTF8-encoded name of the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetPrintability | ( | bool | in_state | ) |
Sets the printability for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.
in_state | The printability for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetTextColor | ( | RGBColor const & | in_color | ) |
Sets the text color for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_sTextColor.
in_color | The text color for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetTextRotation | ( | Text::Rotation | in_rotation | ) |
Sets the text rotation for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eTextOrientation.
in_rotation | The text rotation for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetTooltip | ( | char const * | in_tooltip | ) |
Sets the tooltip for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_pcTooltip.
in_tooltip | UTF8-encoded tooltip text for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::SetVisibility | ( | bool | in_state | ) |
Sets the visibility for the radio button. This corresponds to the value that will be passed to A3DPDFRadioButtonData::m_eFormField.
in_state | The visibility for the radio button. |
void HPS::Publish::RadioButtonKit::Show | ( | RadioButtonKit & | out_kit | ) | const |
Copies this RadioButtonKit into the given RadioButtonKit.
out_kit | The RadioButtonKit to populate with the contents of this RadioButtonKit. |
bool HPS::Publish::RadioButtonKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the radio button.
out_state | Whether the radio button has a border. |
bool HPS::Publish::RadioButtonKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the radio button.
out_color | The border color of the radio button. |
bool HPS::Publish::RadioButtonKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the radio button.
out_style | The border style for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the radio button.
out_thickness | The border thickness for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowDefaultState | ( | bool & | out_default_state | ) | const |
Shows the default state for the radio button.
out_default_state | The default state for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowExportValue | ( | UTF8 & | out_export_value | ) | const |
Shows the export value for the radio button.
out_export_value | The export value for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the radio button.
out_color | The fill color for the radio button. |
bool HPS::Publish::RadioButtonKit::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 radio button.
out_type | The type of font for the radio button. |
out_font | The built-in font for the radio button. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the radio button. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the radio button. This is only valid if out_type is Text::Font::Type::Explicit. |
bool HPS::Publish::RadioButtonKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the radio button.
out_size | The font size for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowGrouping | ( | bool & | out_grouping | ) | const |
Shows the grouping state for the radio button.
out_grouping | The grouping state for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the radio button.
in_state | Whether the radio button is locked. |
bool HPS::Publish::RadioButtonKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the radio button.
out_name | The name of the radio button. |
bool HPS::Publish::RadioButtonKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the radio button.
out_state | The printability for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the radio button.
out_color | The text color for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the radio button.
out_rotation | The text rotation for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the radio button.
out_tooltip | The tooltip text for the radio button. |
bool HPS::Publish::RadioButtonKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the radio button.
out_state | The visibility for the radio button. |
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorder | ( | ) |
Removes the border setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetDefaultState | ( | ) |
Removes the default state setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetEverything | ( | ) |
Removes all data from the radio button.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetExportValue | ( | ) |
Removes the export value setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFont | ( | ) |
Removes the font setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFontSize | ( | ) |
Removes the font size setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetGrouping | ( | ) |
Removes the grouping setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetLock | ( | ) |
Removes the lock setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetName | ( | ) |
Removes the name setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetPrintability | ( | ) |
Removes the printability setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTextColor | ( | ) |
Removes the text color setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetVisibility | ( | ) |
Removes the visibility setting.