#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::RadioButtonKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (RadioButtonKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (RadioButtonKit const &in_kit) const
 
RadioButtonKitoperator= (RadioButtonKit const &in_kit)
 
RadioButtonKitoperator= (RadioButtonKit &&in_kit)
 
bool operator== (RadioButtonKit const &in_kit) const
 
 RadioButtonKit ()
 
 RadioButtonKit (RadioButtonKit const &in_kit)
 
 RadioButtonKit (RadioButtonKit &&in_kit)
 
void Set (RadioButtonKit const &in_kit)
 
RadioButtonKitSetBorder (bool in_state)
 
RadioButtonKitSetBorderColor (RGBColor const &in_color)
 
RadioButtonKitSetBorderStyle (Border::Style in_style)
 
RadioButtonKitSetBorderThickness (Border::Thickness in_thickness)
 
RadioButtonKitSetDefaultState (bool in_state)
 
RadioButtonKitSetExportValue (char const *in_export_value)
 
RadioButtonKitSetFillColor (RGBColor const &in_color)
 
RadioButtonKitSetFont (Text::Font::Name in_name)
 
RadioButtonKitSetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
 
RadioButtonKitSetFontSize (int in_size)
 
RadioButtonKitSetGrouping (bool in_state)
 
RadioButtonKitSetLock (bool in_state)
 
RadioButtonKitSetName (char const *in_name)
 
RadioButtonKitSetPrintability (bool in_state)
 
RadioButtonKitSetTextColor (RGBColor const &in_color)
 
RadioButtonKitSetTextRotation (Text::Rotation in_rotation)
 
RadioButtonKitSetTooltip (char const *in_tooltip)
 
RadioButtonKitSetVisibility (bool in_state)
 
void Show (RadioButtonKit &out_kit) const
 
bool ShowBorder (bool &out_state) const
 
bool ShowBorderColor (RGBColor &out_color) const
 
bool ShowBorderStyle (Border::Style &out_style) const
 
bool ShowBorderThickness (Border::Thickness &out_thickness) const
 
bool ShowDefaultState (bool &out_default_state) const
 
bool ShowExportValue (UTF8 &out_export_value) const
 
bool ShowFillColor (RGBColor &out_color) const
 
bool ShowFont (Text::Font::Type &out_type, Text::Font::Name &out_font, UTF8 &out_font_name, Text::Font::Style &out_style) const
 
bool ShowFontSize (int &out_size) const
 
bool ShowGrouping (bool &out_grouping) const
 
bool ShowLock (bool &out_state) const
 
bool ShowName (UTF8 &out_name) const
 
bool ShowPrintability (bool &out_state) const
 
bool ShowTextColor (RGBColor &out_color) const
 
bool ShowTextRotation (Text::Rotation &out_rotation) const
 
bool ShowTooltip (UTF8 &out_tooltip) const
 
bool ShowVisibility (bool &out_state) const
 
RadioButtonKitUnsetBorder ()
 
RadioButtonKitUnsetBorderColor ()
 
RadioButtonKitUnsetBorderStyle ()
 
RadioButtonKitUnsetBorderThickness ()
 
RadioButtonKitUnsetDefaultState ()
 
RadioButtonKitUnsetEverything ()
 
RadioButtonKitUnsetExportValue ()
 
RadioButtonKitUnsetFillColor ()
 
RadioButtonKitUnsetFont ()
 
RadioButtonKitUnsetFontSize ()
 
RadioButtonKitUnsetGrouping ()
 
RadioButtonKitUnsetLock ()
 
RadioButtonKitUnsetName ()
 
RadioButtonKitUnsetPrintability ()
 
RadioButtonKitUnsetTextColor ()
 
RadioButtonKitUnsetTextRotation ()
 
RadioButtonKitUnsetTooltip ()
 
RadioButtonKitUnsetVisibility ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static RadioButtonKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishRadioButtonKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ RadioButtonKit() [1/3]

HPS::Publish::RadioButtonKit::RadioButtonKit ( )

The default constructor creates an empty RadioButtonKit object.

◆ RadioButtonKit() [2/3]

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.

Parameters
in_kitThe source RadioButtonKit to copy.

◆ RadioButtonKit() [3/3]

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.

Parameters
in_kitAn rvalue reference to a RadioButtonKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Publish::RadioButtonKit::Empty ( ) const
virtual

Indicates whether this RadioButtonKit has any values set on it.

Returns
true if no values are set on this RadioButtonKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Publish::RadioButtonKit::Equals ( RadioButtonKit const &  in_kit) const

Check if the source RadioButtonKit is equivalent to this RadioButtonKit.

Parameters
in_kitThe source RadioButtonKit to compare to this RadioButtonKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static RadioButtonKit HPS::Publish::RadioButtonKit::GetDefault ( )
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.

Returns
A RadioButtonKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Publish::RadioButtonKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Publish::RadioButtonKit::operator!= ( RadioButtonKit const &  in_kit) const

Check if the source RadioButtonKit is not equivalent to this RadioButtonKit.

Parameters
in_kitThe source RadioButtonKit to compare to this RadioButtonKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

RadioButtonKit& HPS::Publish::RadioButtonKit::operator= ( RadioButtonKit const &  in_kit)

Copies the source RadioButtonKit into this RadioButtonKit.

Parameters
in_kitThe source RadioButtonKit to copy.
Returns
A reference to this RadioButtonKit.

◆ operator=() [2/2]

RadioButtonKit& HPS::Publish::RadioButtonKit::operator= ( RadioButtonKit &&  in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this RadioButtonKit.

Parameters
in_kitAn rvalue reference to a RadioButtonKit to take the underlying object from.
Returns
A reference to this RadioButtonKit.

◆ operator==()

bool HPS::Publish::RadioButtonKit::operator== ( RadioButtonKit const &  in_kit) const

Check if the source RadioButtonKit is equivalent to this RadioButtonKit.

Parameters
in_kitThe source RadioButtonKit to compare to this RadioButtonKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::RadioButtonKit::Set ( RadioButtonKit const &  in_kit)

Copies the source RadioButtonKit into this RadioButtonKit.

Parameters
in_kitThe source RadioButtonKit to copy.

◆ SetBorder()

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.

Parameters
in_stateWhether the radio button has a border.
Returns
A reference to this RadioButtonKit.

◆ SetBorderColor()

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.

Parameters
in_colorThe border color of the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetBorderStyle()

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.

Parameters
in_styleThe border style for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetBorderThickness()

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.

Parameters
in_thicknessThe border thickness for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetDefaultState()

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.

Parameters
in_stateWhether the radio button is checked by default.
Returns
A reference to this RadioButtonKit.

◆ SetExportValue()

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.

Parameters
in_export_valueUTF8-encoded export value of the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetFillColor()

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.

Parameters
in_colorThe fill color for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetFont() [1/2]

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.

Parameters
in_nameThe builtin font for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetFont() [2/2]

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.

Parameters
in_nameUTF8-encoded font name for the radio button.
in_styleThe style of font to use for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetFontSize()

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.

Parameters
in_sizeThe font size for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetGrouping()

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.

Parameters
in_stateWhether the radio button is part of a group.
Returns
A reference to this RadioButtonKit.

◆ SetLock()

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.

Parameters
in_stateWhether the radio button is locked.
Returns
A reference to this RadioButtonKit.

◆ SetName()

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.

Parameters
in_nameUTF8-encoded name of the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetPrintability()

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.

Parameters
in_stateThe printability for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetTextColor()

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.

Parameters
in_colorThe text color for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetTextRotation()

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.

Parameters
in_rotationThe text rotation for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetTooltip()

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.

Parameters
in_tooltipUTF8-encoded tooltip text for the radio button.
Returns
A reference to this RadioButtonKit.

◆ SetVisibility()

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.

Parameters
in_stateThe visibility for the radio button.
Returns
A reference to this RadioButtonKit.

◆ Show()

void HPS::Publish::RadioButtonKit::Show ( RadioButtonKit out_kit) const

Copies this RadioButtonKit into the given RadioButtonKit.

Parameters
out_kitThe RadioButtonKit to populate with the contents of this RadioButtonKit.

◆ ShowBorder()

bool HPS::Publish::RadioButtonKit::ShowBorder ( bool &  out_state) const

Shows the border setting for the radio button.

Parameters
out_stateWhether the radio button has a border.
Returns
true if a border setting was specified, false otherwise.

◆ ShowBorderColor()

bool HPS::Publish::RadioButtonKit::ShowBorderColor ( RGBColor out_color) const

Shows the border color for the radio button.

Parameters
out_colorThe border color of the radio button.
Returns
true if a border color was specified, false otherwise.

◆ ShowBorderStyle()

bool HPS::Publish::RadioButtonKit::ShowBorderStyle ( Border::Style out_style) const

Shows the border style for the radio button.

Parameters
out_styleThe border style for the radio button.
Returns
true if a border style was specified, false otherwise.

◆ ShowBorderThickness()

bool HPS::Publish::RadioButtonKit::ShowBorderThickness ( Border::Thickness out_thickness) const

Shows the border thickness for the radio button.

Parameters
out_thicknessThe border thickness for the radio button.
Returns
true if a border thickness was specified, false otherwise.

◆ ShowDefaultState()

bool HPS::Publish::RadioButtonKit::ShowDefaultState ( bool &  out_default_state) const

Shows the default state for the radio button.

Parameters
out_default_stateThe default state for the radio button.
Returns
true if a default state was specified, false otherwise.

◆ ShowExportValue()

bool HPS::Publish::RadioButtonKit::ShowExportValue ( UTF8 out_export_value) const

Shows the export value for the radio button.

Parameters
out_export_valueThe export value for the radio button.
Returns
true if an export value was specified, false otherwise.

◆ ShowFillColor()

bool HPS::Publish::RadioButtonKit::ShowFillColor ( RGBColor out_color) const

Shows the fill color for the radio button.

Parameters
out_colorThe fill color for the radio button.
Returns
true if a fill color was specified, false otherwise.

◆ ShowFont()

bool HPS::Publish::RadioButtonKit::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_typeThe type of font for the radio button.
out_fontThe built-in font for the radio button. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_nameThe explicit font name for the radio button. This is only valid if out_type is Text::Font::Type::Explicit.
out_styleThe 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.

◆ ShowFontSize()

bool HPS::Publish::RadioButtonKit::ShowFontSize ( int &  out_size) const

Shows the font size for the radio button.

Parameters
out_sizeThe font size for the radio button.
Returns
true if a font size was specified, false otherwise.

◆ ShowGrouping()

bool HPS::Publish::RadioButtonKit::ShowGrouping ( bool &  out_grouping) const

Shows the grouping state for the radio button.

Parameters
out_groupingThe grouping state for the radio button.
Returns
true if a groupings state was specified, false otherwise.

◆ ShowLock()

bool HPS::Publish::RadioButtonKit::ShowLock ( bool &  out_state) const

Shows the lock setting for the radio button.

Parameters
in_stateWhether the radio button is locked.
Returns
true if a lock setting was specified, false otherwise.

◆ ShowName()

bool HPS::Publish::RadioButtonKit::ShowName ( UTF8 out_name) const

Shows the name for the radio button.

Parameters
out_nameThe name of the radio button.
Returns
true if a name was specified, false otherwise.

◆ ShowPrintability()

bool HPS::Publish::RadioButtonKit::ShowPrintability ( bool &  out_state) const

Shows the printability for the radio button.

Parameters
out_stateThe printability for the radio button.
Returns
true if a printability was specified, false otherwise.

◆ ShowTextColor()

bool HPS::Publish::RadioButtonKit::ShowTextColor ( RGBColor out_color) const

Shows the text color for the radio button.

Parameters
out_colorThe text color for the radio button.
Returns
true if a text color was specified, false otherwise.

◆ ShowTextRotation()

bool HPS::Publish::RadioButtonKit::ShowTextRotation ( Text::Rotation out_rotation) const

Shows the text rotation for the radio button.

Parameters
out_rotationThe text rotation for the radio button.
Returns
true if a rotation was specified, false otherwise.

◆ ShowTooltip()

bool HPS::Publish::RadioButtonKit::ShowTooltip ( UTF8 out_tooltip) const

Shows the tooltip for the radio button.

Parameters
out_tooltipThe tooltip text for the radio button.
Returns
true if a tooltip was specified, false otherwise.

◆ ShowVisibility()

bool HPS::Publish::RadioButtonKit::ShowVisibility ( bool &  out_state) const

Shows the visibility for the radio button.

Parameters
out_stateThe visibility for the radio button.
Returns
true if a visibility was specified, false otherwise.

◆ UnsetBorder()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorder ( )

Removes the border setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetBorderColor()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderColor ( )

Removes the border color setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetBorderStyle()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetBorderThickness()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetDefaultState()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetDefaultState ( )

Removes the default state setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetEverything()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetEverything ( )

Removes all data from the radio button.

Returns
A reference to this RadioButtonKit.

◆ UnsetExportValue()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetExportValue ( )

Removes the export value setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetFillColor()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFillColor ( )

Removes the fill color setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetFont()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFont ( )

Removes the font setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetFontSize()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetFontSize ( )

Removes the font size setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetGrouping()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetGrouping ( )

Removes the grouping setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetLock()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetLock ( )

Removes the lock setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetName()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetName ( )

Removes the name setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetPrintability()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetPrintability ( )

Removes the printability setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetTextColor()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTextColor ( )

Removes the text color setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetTextRotation()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetTooltip()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns
A reference to this RadioButtonKit.

◆ UnsetVisibility()

RadioButtonKit& HPS::Publish::RadioButtonKit::UnsetVisibility ( )

Removes the visibility setting.

Returns
A reference to this RadioButtonKit.

The documentation for this class was generated from the following file: