HPS::Publish::RadioButtonKit
-
class HPS::Publish::RadioButtonKit : public HPS::SprocketKit
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.
Public Functions
-
virtual bool Empty() const
Indicates whether this RadioButtonKit has any values set on it.
- Returns
true if no values are set on this RadioButtonKit, false otherwise.
-
bool Equals(RadioButtonKit const &in_kit) const
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to compare to this RadioButtonKit.
- Returns
true if the objects are equivalent, false otherwise.
-
inline virtual HPS::Type ObjectType() const
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.
-
bool operator!=(RadioButtonKit const &in_kit) const
Check if the source RadioButtonKit is not equivalent to this RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to compare to this RadioButtonKit.
- Returns
true if the objects are not equivalent, false otherwise.
-
RadioButtonKit &operator=(RadioButtonKit &&in_kit)
The move assignment operator transfers the underlying object of the rvalue reference to this RadioButtonKit.
- Parameters
in_kit – An rvalue reference to a RadioButtonKit to take the underlying object from.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &operator=(RadioButtonKit const &in_kit)
Copies the source RadioButtonKit into this RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to copy.
- Returns
A reference to this RadioButtonKit.
-
bool operator==(RadioButtonKit const &in_kit) const
Check if the source RadioButtonKit is equivalent to this RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to compare to this RadioButtonKit.
- Returns
true if the objects are equivalent, false otherwise.
-
RadioButtonKit()
The default constructor creates an empty RadioButtonKit object.
-
RadioButtonKit(RadioButtonKit &&in_kit)
The move constructor creates a RadioButtonKit by transferring the underlying object of the rvalue reference to this RadioButtonKit.
- Parameters
in_kit – An rvalue reference to a RadioButtonKit to take the underlying object from.
-
RadioButtonKit(RadioButtonKit const &in_kit)
The copy constructor creates a new RadioButtonKit object that contains the same settings as the source RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to copy.
-
void Set(RadioButtonKit const &in_kit)
Copies the source RadioButtonKit into this RadioButtonKit.
- Parameters
in_kit – The source RadioButtonKit to copy.
-
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.
- Parameters
in_state – Whether the radio button has a border.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_color – The border color of the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_style – The border style for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_thickness – The border thickness for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_state – Whether the radio button is checked by default.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_export_value – UTF8-encoded export value of the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_color – The fill color for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_name – UTF8-encoded font name for the radio button.
in_style – The style of font to use for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_name – The builtin font for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_size – The font size for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_state – Whether the radio button is part of a group.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_state – Whether the radio button is locked.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_name – UTF8-encoded name of the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_state – The printability for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_color – The text color for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_rotation – The text rotation for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_tooltip – UTF8-encoded tooltip text for the radio button.
- Returns
A reference to this RadioButtonKit.
-
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.
- Parameters
in_state – The visibility for the radio button.
- Returns
A reference to this RadioButtonKit.
-
void Show(RadioButtonKit &out_kit) const
Copies this RadioButtonKit into the given RadioButtonKit.
- Parameters
out_kit – The RadioButtonKit to populate with the contents of this RadioButtonKit.
-
bool ShowBorder(bool &out_state) const
Shows the border setting for the radio button.
- Parameters
out_state – Whether the radio button has a border.
- Returns
true if a border setting was specified, false otherwise.
-
bool ShowBorderColor(RGBColor &out_color) const
Shows the border color for the radio button.
- Parameters
out_color – The border color of the radio button.
- Returns
true if a border color was specified, false otherwise.
-
bool ShowBorderStyle(Border::Style &out_style) const
Shows the border style for the radio button.
- Parameters
out_style – The border style for the radio button.
- Returns
true if a border style was specified, false otherwise.
-
bool ShowBorderThickness(Border::Thickness &out_thickness) const
Shows the border thickness for the radio button.
- Parameters
out_thickness – The border thickness for the radio button.
- Returns
true if a border thickness was specified, false otherwise.
-
bool ShowDefaultState(bool &out_default_state) const
Shows the default state for the radio button.
- Parameters
out_default_state – The default state for the radio button.
- Returns
true if a default state was specified, false otherwise.
-
bool ShowExportValue(UTF8 &out_export_value) const
Shows the export value for the radio button.
- Parameters
out_export_value – The export value for the radio button.
- Returns
true if an export value was specified, false otherwise.
-
bool ShowFillColor(RGBColor &out_color) const
Shows the fill color for the radio button.
- Parameters
out_color – The fill color for the radio button.
- Returns
true if a fill color was specified, false otherwise.
-
bool 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 radio button.
- Parameters
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.
- Returns
true if a font was specified, false otherwise.
-
bool ShowFontSize(int &out_size) const
Shows the font size for the radio button.
- Parameters
out_size – The font size for the radio button.
- Returns
true if a font size was specified, false otherwise.
-
bool ShowGrouping(bool &out_grouping) const
Shows the grouping state for the radio button.
- Parameters
out_grouping – The grouping state for the radio button.
- Returns
true if a groupings state was specified, false otherwise.
-
bool ShowLock(bool &out_state) const
Shows the lock setting for the radio button.
- Parameters
in_state – Whether the radio button is locked.
- Returns
true if a lock setting was specified, false otherwise.
-
bool ShowName(UTF8 &out_name) const
Shows the name for the radio button.
- Parameters
out_name – The name of the radio button.
- Returns
true if a name was specified, false otherwise.
-
bool ShowPrintability(bool &out_state) const
Shows the printability for the radio button.
- Parameters
out_state – The printability for the radio button.
- Returns
true if a printability was specified, false otherwise.
-
bool ShowTextColor(RGBColor &out_color) const
Shows the text color for the radio button.
- Parameters
out_color – The text color for the radio button.
- Returns
true if a text color was specified, false otherwise.
-
bool ShowTextRotation(Text::Rotation &out_rotation) const
Shows the text rotation for the radio button.
- Parameters
out_rotation – The text rotation for the radio button.
- Returns
true if a rotation was specified, false otherwise.
-
bool ShowTooltip(UTF8 &out_tooltip) const
Shows the tooltip for the radio button.
- Parameters
out_tooltip – The tooltip text for the radio button.
- Returns
true if a tooltip was specified, false otherwise.
-
bool ShowVisibility(bool &out_state) const
Shows the visibility for the radio button.
- Parameters
out_state – The visibility for the radio button.
- Returns
true if a visibility was specified, false otherwise.
-
RadioButtonKit &UnsetBorder()
Removes the border setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetBorderColor()
Removes the border color setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetBorderStyle()
Removes the border style setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetBorderThickness()
Removes the border thickness setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetDefaultState()
Removes the default state setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetEverything()
Removes all data from the radio button.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetExportValue()
Removes the export value setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetFillColor()
Removes the fill color setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetFont()
Removes the font setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetFontSize()
Removes the font size setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetGrouping()
Removes the grouping setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetLock()
Removes the lock setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetName()
Removes the name setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetPrintability()
Removes the printability setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetTextColor()
Removes the text color setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetTextRotation()
Removes the text rotation setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetTooltip()
Removes the tooltip setting.
- Returns
A reference to this RadioButtonKit.
-
RadioButtonKit &UnsetVisibility()
Removes the visibility setting.
- Returns
A reference to this RadioButtonKit.
-
virtual ~RadioButtonKit()
Public Static Functions
-
static RadioButtonKit GetDefault()
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.
- Returns
A RadioButtonKit with the default settings.
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::PublishRadioButtonKit
-
virtual bool Empty() const