#include <sprk_publish.h>

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

Public Member Functions

 ButtonKit ()
 
 ButtonKit (ButtonKit const &in_kit)
 
 ButtonKit (ButtonKit &&in_kit)
 
bool Empty () const
 
bool Equals (ButtonKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ButtonKit const &in_kit) const
 
ButtonKitoperator= (ButtonKit const &in_kit)
 
ButtonKitoperator= (ButtonKit &&in_kit)
 
bool operator== (ButtonKit const &in_kit) const
 
void Set (ButtonKit const &in_kit)
 
ButtonKitSetBorder (bool in_state)
 
ButtonKitSetBorderColor (RGBColor const &in_color)
 
ButtonKitSetBorderStyle (Border::Style in_style)
 
ButtonKitSetBorderThickness (Border::Thickness in_thickness)
 
ButtonKitSetFillColor (RGBColor const &in_color)
 
ButtonKitSetFont (Text::Font::Name in_name)
 
ButtonKitSetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
 
ButtonKitSetFontSize (int in_size)
 
ButtonKitSetHighlighting (Highlighting::Mode in_mode)
 
ButtonKitSetIconImage (ImageKit const &in_image)
 
ButtonKitSetLabel (char const *in_label)
 
ButtonKitSetLabelPosition (Label::Position in_position)
 
ButtonKitSetLock (bool in_state)
 
ButtonKitSetName (char const *in_name)
 
ButtonKitSetPrintability (bool in_state)
 
ButtonKitSetTextColor (RGBColor const &in_color)
 
ButtonKitSetTextRotation (Text::Rotation in_rotation)
 
ButtonKitSetTooltip (char const *in_tooltip)
 
ButtonKitSetVisibility (bool in_state)
 
void Show (ButtonKit &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 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 ShowHighlighting (Highlighting::Mode &out_mode) const
 
bool ShowIconImage (ImageKit &out_image) const
 
bool ShowLabel (UTF8 &out_label) const
 
bool ShowLabelPosition (Label::Position &out_position) 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
 
ButtonKitUnsetBorder ()
 
ButtonKitUnsetBorderColor ()
 
ButtonKitUnsetBorderStyle ()
 
ButtonKitUnsetBorderThickness ()
 
ButtonKitUnsetEverything ()
 
ButtonKitUnsetFillColor ()
 
ButtonKitUnsetFont ()
 
ButtonKitUnsetFontSize ()
 
ButtonKitUnsetHighlighting ()
 
ButtonKitUnsetIconImage ()
 
ButtonKitUnsetLabel ()
 
ButtonKitUnsetLabelPosition ()
 
ButtonKitUnsetLock ()
 
ButtonKitUnsetName ()
 
ButtonKitUnsetPrintability ()
 
ButtonKitUnsetTextColor ()
 
ButtonKitUnsetTextRotation ()
 
ButtonKitUnsetTooltip ()
 
ButtonKitUnsetVisibility ()
 
- 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 ButtonKit 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::PublishButtonKit
 
- 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 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

◆ ButtonKit() [1/3]

HPS::Publish::ButtonKit::ButtonKit ( )

The default constructor creates an empty ButtonKit object.

◆ ButtonKit() [2/3]

HPS::Publish::ButtonKit::ButtonKit ( ButtonKit const &  in_kit)

The copy constructor creates a new ButtonKit object that contains the same settings as the source ButtonKit.

Parameters
in_kitThe source ButtonKit to copy.

◆ ButtonKit() [3/3]

HPS::Publish::ButtonKit::ButtonKit ( ButtonKit &&  in_kit)

The move constructor creates a ButtonKit by transferring the underlying object of the rvalue reference to this ButtonKit.

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

Member Function Documentation

◆ Empty()

bool HPS::Publish::ButtonKit::Empty ( ) const
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.

◆ Equals()

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

Check if the source ButtonKit is equivalent to this ButtonKit.

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

◆ GetDefault()

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

◆ ObjectType()

HPS::Type HPS::Publish::ButtonKit::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::ButtonKit::operator!= ( ButtonKit const &  in_kit) const

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

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

◆ operator=() [1/2]

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

Copies the source ButtonKit into this ButtonKit.

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

◆ operator=() [2/2]

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

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

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

◆ operator==()

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

Check if the source ButtonKit is equivalent to this ButtonKit.

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

◆ Set()

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

Copies the source ButtonKit into this ButtonKit.

Parameters
in_kitThe source ButtonKit to copy.

◆ SetBorder()

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_stateWhether the button has a border.
Returns
A reference to this ButtonKit.

◆ SetBorderColor()

ButtonKit& HPS::Publish::ButtonKit::SetBorderColor ( RGBColor const &  in_color)

Sets the border color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sBorderColor.

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

◆ SetBorderStyle()

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_styleThe border style for the button.
Returns
A reference to this ButtonKit.

◆ SetBorderThickness()

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_thicknessThe border thickness for the button.
Returns
A reference to this ButtonKit.

◆ SetFillColor()

ButtonKit& HPS::Publish::ButtonKit::SetFillColor ( RGBColor const &  in_color)

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_colorThe fill color for the button.
Returns
A reference to this ButtonKit.

◆ SetFont() [1/2]

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_nameThe builtin font for the button.
Returns
A reference to this ButtonKit.

◆ SetFont() [2/2]

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_nameUTF8-encoded font name for the button.
in_styleThe style of font to use for the button.
Returns
A reference to this ButtonKit.

◆ SetFontSize()

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_sizeThe font size for the button.
Returns
A reference to this ButtonKit.

◆ SetHighlighting()

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_modeThe highlighting mode for the button.
Returns
A reference to this ButtonKit.

◆ SetIconImage()

ButtonKit& HPS::Publish::ButtonKit::SetIconImage ( ImageKit const &  in_image)

Sets the icon image for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_pImage.

Parameters
in_imageThe icon image for the button.
Returns
A reference to this ButtonKit.

◆ SetLabel()

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_labelUTF8-encoded label for the button.
Returns
A reference to this ButtonKit.

◆ SetLabelPosition()

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_positionThe label position for the button.
Returns
A reference to this ButtonKit.

◆ SetLock()

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_stateWhether the button is locked.
Returns
A reference to this ButtonKit.

◆ SetName()

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_nameUTF8-encoded name of the button.
Returns
A reference to this ButtonKit.

◆ SetPrintability()

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_stateThe printability for the button.
Returns
A reference to this ButtonKit.

◆ SetTextColor()

ButtonKit& HPS::Publish::ButtonKit::SetTextColor ( RGBColor const &  in_color)

Sets the text color for the button. This corresponds to the value that will be passed to A3DPDFButtonData::m_sTextColor.

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

◆ SetTextRotation()

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_rotationThe text rotation for the button.
Returns
A reference to this ButtonKit.

◆ SetTooltip()

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_tooltipUTF8-encoded tooltip text for the button.
Returns
A reference to this ButtonKit.

◆ SetVisibility()

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_stateThe visibility for the button.
Returns
A reference to this ButtonKit.

◆ Show()

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

Copies this ButtonKit into the given ButtonKit.

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

◆ ShowBorder()

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

Shows the border setting for the button.

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

◆ ShowBorderColor()

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

Shows the border color for the button.

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

◆ ShowBorderStyle()

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

Shows the border style for the button.

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

◆ ShowBorderThickness()

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

Shows the border thickness for the button.

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

◆ ShowFillColor()

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

Shows the fill color for the button.

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

◆ ShowFont()

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

◆ ShowFontSize()

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

Shows the font size for the button.

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

◆ ShowHighlighting()

bool HPS::Publish::ButtonKit::ShowHighlighting ( Highlighting::Mode out_mode) const

Shows the highlighting mode for the button.

Parameters
out_modeThe highlighting mode for the button.
Returns
true if a highlighting mode was specified, false otherwise.

◆ ShowIconImage()

bool HPS::Publish::ButtonKit::ShowIconImage ( ImageKit out_image) const

Shows the icon image for the button.

Parameters
out_imageThe icon image for the button.
Returns
true if an icon image was specified, false otherwise.

◆ ShowLabel()

bool HPS::Publish::ButtonKit::ShowLabel ( UTF8 out_label) const

Shows the label for the button.

Parameters
out_labelThe label for the button.
Returns
true if a label was specified, false otherwise.

◆ ShowLabelPosition()

bool HPS::Publish::ButtonKit::ShowLabelPosition ( Label::Position out_position) const

Shows the label position for the button.

Parameters
out_positionThe label position for the button.
Returns
true if a label position was specified, false otherwise.

◆ ShowLock()

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

Shows the lock setting for the button.

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

◆ ShowName()

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

Shows the name for the button.

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

◆ ShowPrintability()

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

Shows the printability for the button.

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

◆ ShowTextColor()

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

Shows the text color for the button.

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

◆ ShowTextRotation()

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

Shows the text rotation for the button.

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

◆ ShowTooltip()

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

Shows the tooltip for the button.

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

◆ ShowVisibility()

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

Shows the visibility for the button.

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

◆ UnsetBorder()

ButtonKit& HPS::Publish::ButtonKit::UnsetBorder ( )

Removes the border setting.

Returns
A reference to this ButtonKit.

◆ UnsetBorderColor()

ButtonKit& HPS::Publish::ButtonKit::UnsetBorderColor ( )

Removes the border color setting.

Returns
A reference to this ButtonKit.

◆ UnsetBorderStyle()

ButtonKit& HPS::Publish::ButtonKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns
A reference to this ButtonKit.

◆ UnsetBorderThickness()

ButtonKit& HPS::Publish::ButtonKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns
A reference to this ButtonKit.

◆ UnsetEverything()

ButtonKit& HPS::Publish::ButtonKit::UnsetEverything ( )

Removes all data from the button.

Returns
A reference to this ButtonKit.

◆ UnsetFillColor()

ButtonKit& HPS::Publish::ButtonKit::UnsetFillColor ( )

Removes the fill color setting.

Returns
A reference to this ButtonKit.

◆ UnsetFont()

ButtonKit& HPS::Publish::ButtonKit::UnsetFont ( )

Removes the font setting.

Returns
A reference to this ButtonKit.

◆ UnsetFontSize()

ButtonKit& HPS::Publish::ButtonKit::UnsetFontSize ( )

Removes the font size setting.

Returns
A reference to this ButtonKit.

◆ UnsetHighlighting()

ButtonKit& HPS::Publish::ButtonKit::UnsetHighlighting ( )

Removes the highlighting mode setting.

Returns
A reference to this ButtonKit.

◆ UnsetIconImage()

ButtonKit& HPS::Publish::ButtonKit::UnsetIconImage ( )

Removes the icon image setting.

Returns
A reference to this ButtonKit.

◆ UnsetLabel()

ButtonKit& HPS::Publish::ButtonKit::UnsetLabel ( )

Removes the label setting.

Returns
A reference to this ButtonKit.

◆ UnsetLabelPosition()

ButtonKit& HPS::Publish::ButtonKit::UnsetLabelPosition ( )

Removes the label position setting.

Returns
A reference to this ButtonKit.

◆ UnsetLock()

ButtonKit& HPS::Publish::ButtonKit::UnsetLock ( )

Removes the lock setting.

Returns
A reference to this ButtonKit.

◆ UnsetName()

ButtonKit& HPS::Publish::ButtonKit::UnsetName ( )

Removes the name setting.

Returns
A reference to this ButtonKit.

◆ UnsetPrintability()

ButtonKit& HPS::Publish::ButtonKit::UnsetPrintability ( )

Removes the printability setting.

Returns
A reference to this ButtonKit.

◆ UnsetTextColor()

ButtonKit& HPS::Publish::ButtonKit::UnsetTextColor ( )

Removes the text color setting.

Returns
A reference to this ButtonKit.

◆ UnsetTextRotation()

ButtonKit& HPS::Publish::ButtonKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns
A reference to this ButtonKit.

◆ UnsetTooltip()

ButtonKit& HPS::Publish::ButtonKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns
A reference to this ButtonKit.

◆ UnsetVisibility()

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: