API Search || Global Search

#include <sprk_publish.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (SignatureFieldKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (SignatureFieldKit const &in_kit) const
 
SignatureFieldKitoperator= (SignatureFieldKit const &in_kit)
 
SignatureFieldKitoperator= (SignatureFieldKit &&in_kit)
 
bool operator== (SignatureFieldKit const &in_kit) const
 
void Set (SignatureFieldKit const &in_kit)
 
SignatureFieldKitSetBorder (bool in_state)
 
SignatureFieldKitSetBorderColor (RGBColor const &in_color)
 
SignatureFieldKitSetBorderStyle (Border::Style in_style)
 
SignatureFieldKitSetBorderThickness (Border::Thickness in_thickness)
 
SignatureFieldKitSetFillColor (RGBColor const &in_color)
 
SignatureFieldKitSetFont (Text::Font::Name in_name)
 
SignatureFieldKitSetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
 
SignatureFieldKitSetFontSize (int in_size)
 
SignatureFieldKitSetLock (bool in_state)
 
SignatureFieldKitSetName (char const *in_name)
 
SignatureFieldKitSetPrintability (bool in_state)
 
SignatureFieldKitSetTextColor (RGBColor const &in_color)
 
SignatureFieldKitSetTextRotation (Text::Rotation in_rotation)
 
SignatureFieldKitSetTooltip (char const *in_tooltip)
 
SignatureFieldKitSetVisibility (bool in_state)
 
void Show (SignatureFieldKit &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 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
 
 SignatureFieldKit ()
 
 SignatureFieldKit (SignatureFieldKit const &in_kit)
 
 SignatureFieldKit (SignatureFieldKit &&in_kit)
 
SignatureFieldKitUnsetBorder ()
 
SignatureFieldKitUnsetBorderColor ()
 
SignatureFieldKitUnsetBorderStyle ()
 
SignatureFieldKitUnsetBorderThickness ()
 
SignatureFieldKitUnsetEverything ()
 
SignatureFieldKitUnsetFillColor ()
 
SignatureFieldKitUnsetFont ()
 
SignatureFieldKitUnsetFontSize ()
 
SignatureFieldKitUnsetLock ()
 
SignatureFieldKitUnsetName ()
 
SignatureFieldKitUnsetPrintability ()
 
SignatureFieldKitUnsetTextColor ()
 
SignatureFieldKitUnsetTextRotation ()
 
SignatureFieldKitUnsetTooltip ()
 
SignatureFieldKitUnsetVisibility ()
 
- 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 SignatureFieldKit 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::PublishSignatureFieldKit
 
- 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 SignatureFieldKit class is a user space object. It acts as the container for all data that can be used to specify a signature field for a Publish PDF.

Constructor & Destructor Documentation

HPS::Publish::SignatureFieldKit::SignatureFieldKit ( )

The default constructor creates an empty SignatureFieldKit object.

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

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

Parameters
in_kitThe source SignatureFieldKit to copy.
HPS::Publish::SignatureFieldKit::SignatureFieldKit ( SignatureFieldKit &&  in_kit)

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

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

Member Function Documentation

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

Indicates whether this SignatureFieldKit has any values set on it.

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

Reimplemented from HPS::Object.

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

Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to compare to this SignatureFieldKit.
Returns
true if the objects are equivalent, false otherwise.
static SignatureFieldKit HPS::Publish::SignatureFieldKit::GetDefault ( )
static

Creates a SignatureFieldKit 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 SignatureFieldKit passed to a function.

Returns
A SignatureFieldKit with the default settings.
bool HPS::Publish::SignatureFieldKit::operator!= ( SignatureFieldKit const &  in_kit) const

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

Parameters
in_kitThe source SignatureFieldKit to compare to this SignatureFieldKit.
Returns
true if the objects are not equivalent, false otherwise.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::operator= ( SignatureFieldKit const &  in_kit)

Copies the source SignatureFieldKit into this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to copy.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::operator= ( SignatureFieldKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to a SignatureFieldKit to take the underlying object from.
Returns
A reference to this SignatureFieldKit.
bool HPS::Publish::SignatureFieldKit::operator== ( SignatureFieldKit const &  in_kit) const

Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to compare to this SignatureFieldKit.
Returns
true if the objects are equivalent, false otherwise.
void HPS::Publish::SignatureFieldKit::Set ( SignatureFieldKit const &  in_kit)

Copies the source SignatureFieldKit into this SignatureFieldKit.

Parameters
in_kitThe source SignatureFieldKit to copy.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorder ( bool  in_state)

Sets whether the signature field has a border. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bHasBorder.

Parameters
in_stateWhether the signature field has a border.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderColor ( RGBColor const &  in_color)

Sets the border color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sBorderColor.

Parameters
in_colorThe border color of the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderStyle ( Border::Style  in_style)

Sets the border style for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eLineStyleBorder.

Parameters
in_styleThe border style for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderThickness ( Border::Thickness  in_thickness)

Sets the border thickness for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eThicknessBorder.

Parameters
in_thicknessThe border thickness for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFillColor ( RGBColor const &  in_color)

Sets the fill color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sFillColor and implicitly sets A3DPDFDigitalSignatureData::m_bHasFillColor to true.

Parameters
in_colorThe fill color for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFont ( Text::Font::Name  in_name)

Sets a builtin font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.

Parameters
in_nameThe builtin font for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFont ( char const *  in_name,
Text::Font::Style  in_style = Text::Font::Style::Regular 
)

Sets a specific font for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.

Parameters
in_nameUTF8-encoded font name for the signature field.
in_styleThe style of font to use for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFontSize ( int  in_size)

Sets the font size for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_iFontSize.

Parameters
in_sizeThe font size for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetLock ( bool  in_state)

Sets whether the signature field is locked. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bIsLocked.

Parameters
in_stateWhether the signature field is locked.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetName ( char const *  in_name)

Sets the name of the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcName.

Parameters
in_nameUTF8-encoded name of the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetPrintability ( bool  in_state)

Sets the printability for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.

Parameters
in_stateThe printability for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTextColor ( RGBColor const &  in_color)

Sets the text color for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sTextColor.

Parameters
in_colorThe text color for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTextRotation ( Text::Rotation  in_rotation)

Sets the text rotation for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eTextOrientation.

Parameters
in_rotationThe text rotation for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTooltip ( char const *  in_tooltip)

Sets the tooltip for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcTooltip.

Parameters
in_tooltipUTF8-encoded tooltip text for the signature field.
Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetVisibility ( bool  in_state)

Sets the visibility for the signature field. This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.

Parameters
in_stateThe visibility for the signature field.
Returns
A reference to this SignatureFieldKit.
void HPS::Publish::SignatureFieldKit::Show ( SignatureFieldKit out_kit) const

Copies this SignatureFieldKit into the given SignatureFieldKit.

Parameters
out_kitThe SignatureFieldKit to populate with the contents of this SignatureFieldKit.
bool HPS::Publish::SignatureFieldKit::ShowBorder ( bool &  out_state) const

Shows the border setting for the signature field.

Parameters
out_stateWhether the signature field has a border.
Returns
true if a border setting was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowBorderColor ( RGBColor out_color) const

Shows the border color for the signature field.

Parameters
out_colorThe border color of the signature field.
Returns
true if a border color was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowBorderStyle ( Border::Style out_style) const

Shows the border style for the signature field.

Parameters
out_styleThe border style for the signature field.
Returns
true if a border style was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowBorderThickness ( Border::Thickness out_thickness) const

Shows the border thickness for the signature field.

Parameters
out_thicknessThe border thickness for the signature field.
Returns
true if a border thickness was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowFillColor ( RGBColor out_color) const

Shows the fill color for the signature field.

Parameters
out_colorThe fill color for the signature field.
Returns
true if a fill color was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::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 signature field.

Parameters
out_typeThe type of font for the signature field.
out_fontThe built-in font for the signature field. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_nameThe explicit font name for the signature field. This is only valid if out_type is Text::Font::Type::Explicit.
out_styleThe font style for the signature field. This is only valid if out_type is Text::Font::Type::Explicit.
Returns
true if a font was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowFontSize ( int &  out_size) const

Shows the font size for the signature field.

Parameters
out_sizeThe font size for the signature field.
Returns
true if a font size was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowLock ( bool &  out_state) const

Shows the lock setting for the signature field.

Parameters
in_stateWhether the signature field is locked.
Returns
true if a lock setting was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowName ( UTF8 out_name) const

Shows the name for the signature field.

Parameters
out_nameThe name of the signature field.
Returns
true if a name was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowPrintability ( bool &  out_state) const

Shows the printability for the signature field.

Parameters
out_stateThe printability for the signature field.
Returns
true if a printability was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowTextColor ( RGBColor out_color) const

Shows the text color for the signature field.

Parameters
out_colorThe text color for the signature field.
Returns
true if a text color was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowTextRotation ( Text::Rotation out_rotation) const

Shows the text rotation for the signature field.

Parameters
out_rotationThe text rotation for the signature field.
Returns
true if a rotation was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowTooltip ( UTF8 out_tooltip) const

Shows the tooltip for the signature field.

Parameters
out_tooltipThe tooltip text for the signature field.
Returns
true if a tooltip was specified, false otherwise.
bool HPS::Publish::SignatureFieldKit::ShowVisibility ( bool &  out_state) const

Shows the visibility for the signature field.

Parameters
out_stateThe visibility for the signature field.
Returns
true if a visibility was specified, false otherwise.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorder ( )

Removes the border setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderColor ( )

Removes the border color setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetEverything ( )

Removes all data from the signature field.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFillColor ( )

Removes the fill color setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFont ( )

Removes the font setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFontSize ( )

Removes the font size setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetLock ( )

Removes the lock setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetName ( )

Removes the name setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetPrintability ( )

Removes the printability setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTextColor ( )

Removes the text color setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns
A reference to this SignatureFieldKit.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetVisibility ( )

Removes the visibility setting.

Returns
A reference to this SignatureFieldKit.

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