The CheckBoxKit class is a user space object. More...

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::CheckBoxKit:

Collaboration diagram for HPS::Publish::CheckBoxKit:

Public Member Functions
	CheckBoxKit ()
	The default constructor creates an empty CheckBoxKit object. More...

	CheckBoxKit (CheckBoxKit const &in_kit)
	The copy constructor creates a new CheckBoxKit object that contains the same settings as the source CheckBoxKit. More...

	CheckBoxKit (CheckBoxKit &&in_kit)
	The move constructor creates a CheckBoxKit by transferring the underlying object of the rvalue reference to this CheckBoxKit. More...

virtual	~CheckBoxKit ()

HPS::Type	ObjectType () const

void	Set (CheckBoxKit const &in_kit)
	Copies the source CheckBoxKit into this CheckBoxKit. More...

void	Show (CheckBoxKit &out_kit) const
	Copies this CheckBoxKit into the given CheckBoxKit. More...

CheckBoxKit &	operator= (CheckBoxKit const &in_kit)
	Copies the source CheckBoxKit into this CheckBoxKit. More...

CheckBoxKit &	operator= (CheckBoxKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this CheckBoxKit. More...

bool	Empty () const
	Indicates whether this CheckBoxKit has any values set on it. More...

bool	Equals (CheckBoxKit const &in_kit) const
	Check if the source CheckBoxKit is equivalent to this CheckBoxKit. More...

bool	operator== (CheckBoxKit const &in_kit) const
	Check if the source CheckBoxKit is equivalent to this CheckBoxKit. More...

bool	operator!= (CheckBoxKit const &in_kit) const
	Check if the source CheckBoxKit is not equivalent to this CheckBoxKit. More...

CheckBoxKit &	SetName (char const *in_name)
	Sets the name of the check box. More...

CheckBoxKit &	SetFont (Text::Font::Name in_name)
	Sets a builtin font for the check box. More...

CheckBoxKit &	SetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
	Sets a specific font for the check box. More...

CheckBoxKit &	SetFontSize (int in_size)
	Sets the font size for the check box. More...

CheckBoxKit &	SetTextColor (RGBColor const &in_color)
	Sets the text color for the check box. More...

CheckBoxKit &	SetTooltip (char const *in_tooltip)
	Sets the tooltip for the check box. More...

CheckBoxKit &	SetVisibility (bool in_state)
	Sets the visibility for the check box. More...

CheckBoxKit &	SetPrintability (bool in_state)
	Sets the printability for the check box. More...

CheckBoxKit &	SetTextRotation (Text::Rotation in_rotation)
	Sets the text rotation for the check box. More...

CheckBoxKit &	SetLock (bool in_state)
	Sets whether the check box is locked. More...

CheckBoxKit &	SetBorder (bool in_state)
	Sets whether the check box has a border. More...

CheckBoxKit &	SetBorderColor (RGBColor const &in_color)
	Sets the border color for the check box. More...

CheckBoxKit &	SetBorderThickness (Border::Thickness in_thickness)
	Sets the border thickness for the check box. More...

CheckBoxKit &	SetBorderStyle (Border::Style in_style)
	Sets the border style for the check box. More...

CheckBoxKit &	SetFillColor (RGBColor const &in_color)
	Sets the fill color for the check box. More...

CheckBoxKit &	SetExportValue (char const *in_export_value)
	Sets the export value used when field data is exported by Acrobat functions. More...

CheckBoxKit &	SetDefaultState (bool in_state)
	Sets whether the check box is checked by default. More...

CheckBoxKit &	UnsetName ()
	Removes the name setting. More...

CheckBoxKit &	UnsetFont ()
	Removes the font setting. More...

CheckBoxKit &	UnsetFontSize ()
	Removes the font size setting. More...

CheckBoxKit &	UnsetTextColor ()
	Removes the text color setting. More...

CheckBoxKit &	UnsetTooltip ()
	Removes the tooltip setting. More...

CheckBoxKit &	UnsetVisibility ()
	Removes the visibility setting. More...

CheckBoxKit &	UnsetPrintability ()
	Removes the printability setting. More...

CheckBoxKit &	UnsetTextRotation ()
	Removes the text rotation setting. More...

CheckBoxKit &	UnsetLock ()
	Removes the lock setting. More...

CheckBoxKit &	UnsetBorder ()
	Removes the border setting. More...

CheckBoxKit &	UnsetBorderColor ()
	Removes the border color setting. More...

CheckBoxKit &	UnsetBorderThickness ()
	Removes the border thickness setting. More...

CheckBoxKit &	UnsetBorderStyle ()
	Removes the border style setting. More...

CheckBoxKit &	UnsetFillColor ()
	Removes the fill color setting. More...

CheckBoxKit &	UnsetExportValue ()
	Removes the export value setting. More...

CheckBoxKit &	UnsetDefaultState ()
	Removes the default state setting. More...

CheckBoxKit &	UnsetEverything ()
	Removes all data from the check box. More...

bool	ShowName (UTF8 &out_name) const
	Shows the name for the check box. More...

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 check box. More...

bool	ShowFontSize (int &out_size) const
	Shows the font size for the check box. More...

bool	ShowTextColor (RGBColor &out_color) const
	Shows the text color for the check box. More...

bool	ShowTooltip (UTF8 &out_tooltip) const
	Shows the tooltip for the check box. More...

bool	ShowVisibility (bool &out_state) const
	Shows the visibility for the check box. More...

bool	ShowPrintability (bool &out_state) const
	Shows the printability for the check box. More...

bool	ShowTextRotation (Text::Rotation &out_rotation) const
	Shows the text rotation for the check box. More...

bool	ShowLock (bool &out_state) const
	Shows the lock setting for the check box. More...

bool	ShowBorder (bool &out_state) const
	Shows the border setting for the check box. More...

bool	ShowBorderColor (RGBColor &out_color) const
	Shows the border color for the check box. More...

bool	ShowBorderThickness (Border::Thickness &out_thickness) const
	Shows the border thickness for the check box. More...

bool	ShowBorderStyle (Border::Style &out_style) const
	Shows the border style for the check box. More...

bool	ShowFillColor (RGBColor &out_color) const
	Shows the fill color for the check box. More...

bool	ShowExportValue (UTF8 &out_export_value) const
	Shows the export value for the check box. More...

bool	ShowDefaultState (bool &out_default_state) const
	Shows the default state for the check box. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static CheckBoxKit	GetDefault ()
	Creates a CheckBoxKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PublishCheckBoxKit

Detailed Description

The CheckBoxKit class is a user space object.

It acts as the container for all data that can be used to specify a check box for a Publish PDF.

Constructor & Destructor Documentation

◆ CheckBoxKit() [1/3]

HPS::Publish::CheckBoxKit::CheckBoxKit ( )

The default constructor creates an empty CheckBoxKit object.

◆ CheckBoxKit() [2/3]

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

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

Parameters

in_kit The source CheckBoxKit to copy.

◆ CheckBoxKit() [3/3]

HPS::Publish::CheckBoxKit::CheckBoxKit ( CheckBoxKit && in_kit )

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

Parameters

in_kit An rvalue reference to a CheckBoxKit to take the underlying object from.

◆ ~CheckBoxKit()

virtual HPS::Publish::CheckBoxKit::~CheckBoxKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::Publish::CheckBoxKit::Empty ( ) const

virtual

Indicates whether this CheckBoxKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

Parameters

in_kit The source CheckBoxKit to compare to this CheckBoxKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetDefault()

static CheckBoxKit HPS::Publish::CheckBoxKit::GetDefault ( )

static

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

Returns: A CheckBoxKit with the default settings.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Publish::CheckBoxKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source CheckBoxKit to compare to this CheckBoxKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

Copies the source CheckBoxKit into this CheckBoxKit.

Parameters

in_kit The source CheckBoxKit to copy.

Returns: A reference to this CheckBoxKit.

◆ operator=() [2/2]

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

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

Parameters

in_kit An rvalue reference to a CheckBoxKit to take the underlying object from.

Returns: A reference to this CheckBoxKit.

◆ operator==()

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

Check if the source CheckBoxKit is equivalent to this CheckBoxKit.

Parameters

in_kit The source CheckBoxKit to compare to this CheckBoxKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source CheckBoxKit into this CheckBoxKit.

Parameters

in_kit The source CheckBoxKit to copy.

◆ SetBorder()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorder ( bool in_state )

Sets whether the check box has a border.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bHasBorder.

Parameters

in_state Whether the check box has a border.

Returns: A reference to this CheckBoxKit.

◆ SetBorderColor()

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

Sets the border color for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sBorderColor.

Parameters

in_color The border color of the check box.

Returns: A reference to this CheckBoxKit.

◆ SetBorderStyle()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorderStyle ( Border::Style in_style )

Sets the border style for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eLineStyleBorder.

Parameters

in_style The border style for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetBorderThickness()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetBorderThickness ( Border::Thickness in_thickness )

Sets the border thickness for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eThicknessBorder.

Parameters

in_thickness The border thickness for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetDefaultState()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetDefaultState ( bool in_state )

Sets whether the check box is checked by default.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsCheckedByDefault.

Parameters

in_state Whether the check box is checked by default.

Returns: A reference to this CheckBoxKit.

◆ SetExportValue()

CheckBoxKit& HPS::Publish::CheckBoxKit::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 A3DPDFCheckBoxData::m_pcExportValue.

Parameters

in_export_value UTF8-encoded export value of the check box.

Returns: A reference to this CheckBoxKit.

◆ SetFillColor()

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

Sets the fill color for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sFillColor and implicitly sets A3DPDFCheckBoxData::m_bHasFillColor to true.

Parameters

in_color The fill color for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetFont() [1/2]

CheckBoxKit& HPS::Publish::CheckBoxKit::SetFont ( Text::Font::Name in_name )

Sets a builtin font for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.

Parameters

in_name The builtin font for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetFont() [2/2]

CheckBoxKit& HPS::Publish::CheckBoxKit::SetFont	(	char const *	in_name,
		Text::Font::Style	in_style = `Text::Font::Style::Regular`
	)

Sets a specific font for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcFontName.

Parameters

in_name	UTF8-encoded font name for the check box.
in_style	The style of font to use for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetFontSize()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetFontSize ( int in_size )

Sets the font size for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_iFontSize.

Parameters

in_size The font size for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetLock()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetLock ( bool in_state )

Sets whether the check box is locked.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_bIsLocked.

Parameters

in_state Whether the check box is locked.

Returns: A reference to this CheckBoxKit.

◆ SetName()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetName ( char const * in_name )

Sets the name of the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcName.

Parameters

in_name UTF8-encoded name of the check box.

Returns: A reference to this CheckBoxKit.

◆ SetPrintability()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetPrintability ( bool in_state )

Sets the printability for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.

Parameters

in_state The printability for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetTextColor()

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

Sets the text color for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_sTextColor.

Parameters

in_color The text color for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetTextRotation()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetTextRotation ( Text::Rotation in_rotation )

Sets the text rotation for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eTextOrientation.

Parameters

in_rotation The text rotation for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetTooltip()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetTooltip ( char const * in_tooltip )

Sets the tooltip for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_pcTooltip.

Parameters

in_tooltip UTF8-encoded tooltip text for the check box.

Returns: A reference to this CheckBoxKit.

◆ SetVisibility()

CheckBoxKit& HPS::Publish::CheckBoxKit::SetVisibility ( bool in_state )

Sets the visibility for the check box.

This corresponds to the value that will be passed to A3DPDFCheckBoxData::m_eFormField.

Parameters

in_state The visibility for the check box.

Returns: A reference to this CheckBoxKit.

◆ Show()

void HPS::Publish::CheckBoxKit::Show ( CheckBoxKit & out_kit ) const

Copies this CheckBoxKit into the given CheckBoxKit.

Parameters

out_kit The CheckBoxKit to populate with the contents of this CheckBoxKit.

◆ ShowBorder()

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

Shows the border setting for the check box.

Parameters

out_state Whether the check box has a border.

Returns: true if a border setting was specified, false otherwise.

◆ ShowBorderColor()

bool HPS::Publish::CheckBoxKit::ShowBorderColor ( RGBColor & out_color ) const

Shows the border color for the check box.

Parameters

out_color The border color of the check box.

Returns: true if a border color was specified, false otherwise.

◆ ShowBorderStyle()

bool HPS::Publish::CheckBoxKit::ShowBorderStyle ( Border::Style & out_style ) const

Shows the border style for the check box.

Parameters

out_style The border style for the check box.

Returns: true if a border style was specified, false otherwise.

◆ ShowBorderThickness()

bool HPS::Publish::CheckBoxKit::ShowBorderThickness ( Border::Thickness & out_thickness ) const

Shows the border thickness for the check box.

Parameters

out_thickness The border thickness for the check box.

Returns: true if a border thickness was specified, false otherwise.

◆ ShowDefaultState()

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

Shows the default state for the check box.

Parameters

out_default_state The default state for the check box.

Returns: true if a default state was specified, false otherwise.

◆ ShowExportValue()

bool HPS::Publish::CheckBoxKit::ShowExportValue ( UTF8 & out_export_value ) const

Shows the export value for the check box.

Parameters

out_export_value The export value for the check box.

Returns: true if an export value was specified, false otherwise.

◆ ShowFillColor()

bool HPS::Publish::CheckBoxKit::ShowFillColor ( RGBColor & out_color ) const

Shows the fill color for the check box.

Parameters

out_color The fill color for the check box.

Returns: true if a fill color was specified, false otherwise.

◆ ShowFont()

bool HPS::Publish::CheckBoxKit::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 check box.

Parameters

out_type	The type of font for the check box.
out_font	The built-in font for the check box. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_name	The explicit font name for the check box. This is only valid if out_type is Text::Font::Type::Explicit.
out_style	The font style for the check box. 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::CheckBoxKit::ShowFontSize ( int & out_size ) const

Shows the font size for the check box.

Parameters

out_size The font size for the check box.

Returns: true if a font size was specified, false otherwise.

◆ ShowLock()

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

Shows the lock setting for the check box.

Parameters

in_state Whether the check box is locked.

Returns: true if a lock setting was specified, false otherwise.

◆ ShowName()

bool HPS::Publish::CheckBoxKit::ShowName ( UTF8 & out_name ) const

Shows the name for the check box.

Parameters

out_name The name of the check box.

Returns: true if a name was specified, false otherwise.

◆ ShowPrintability()

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

Shows the printability for the check box.

Parameters

out_state The printability for the check box.

Returns: true if a printability was specified, false otherwise.

◆ ShowTextColor()

bool HPS::Publish::CheckBoxKit::ShowTextColor ( RGBColor & out_color ) const

Shows the text color for the check box.

Parameters

out_color The text color for the check box.

Returns: true if a text color was specified, false otherwise.

◆ ShowTextRotation()

bool HPS::Publish::CheckBoxKit::ShowTextRotation ( Text::Rotation & out_rotation ) const

Shows the text rotation for the check box.

Parameters

out_rotation The text rotation for the check box.

Returns: true if a rotation was specified, false otherwise.

◆ ShowTooltip()

bool HPS::Publish::CheckBoxKit::ShowTooltip ( UTF8 & out_tooltip ) const

Shows the tooltip for the check box.

Parameters

out_tooltip The tooltip text for the check box.

Returns: true if a tooltip was specified, false otherwise.

◆ ShowVisibility()

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

Shows the visibility for the check box.

Parameters

out_state The visibility for the check box.

Returns: true if a visibility was specified, false otherwise.

◆ Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

◆ UnsetBorder()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorder ( )

Removes the border setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetBorderColor()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderColor ( )

Removes the border color setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetBorderStyle()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetBorderThickness()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetDefaultState()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetDefaultState ( )

Removes the default state setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetEverything()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetEverything ( )

Removes all data from the check box.

Returns: A reference to this CheckBoxKit.

◆ UnsetExportValue()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetExportValue ( )

Removes the export value setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetFillColor()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFillColor ( )

Removes the fill color setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetFont()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFont ( )

Removes the font setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetFontSize()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetFontSize ( )

Removes the font size setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetLock()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetLock ( )

Removes the lock setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetName()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetName ( )

Removes the name setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetPrintability()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetPrintability ( )

Removes the printability setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetTextColor()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextColor ( )

Removes the text color setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetTextRotation()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetTooltip()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns: A reference to this CheckBoxKit.

◆ UnsetVisibility()

CheckBoxKit& HPS::Publish::CheckBoxKit::UnsetVisibility ( )

Removes the visibility setting.

Returns: A reference to this CheckBoxKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Publish::CheckBoxKit::staticType = HPS::Type::PublishCheckBoxKit

static

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

sprk_publish.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CheckBoxKit() [1/3]

◆ CheckBoxKit() [2/3]

◆ CheckBoxKit() [3/3]

◆ ~CheckBoxKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBorder()

◆ SetBorderColor()

◆ SetBorderStyle()

◆ SetBorderThickness()

◆ SetDefaultState()

◆ SetExportValue()

◆ SetFillColor()

◆ SetFont() [1/2]

◆ SetFont() [2/2]

◆ SetFontSize()

◆ SetLock()

◆ SetName()

◆ SetPrintability()

◆ SetTextColor()

◆ SetTextRotation()

◆ SetTooltip()

◆ SetVisibility()

◆ Show()

◆ ShowBorder()

◆ ShowBorderColor()

◆ ShowBorderStyle()

◆ ShowBorderThickness()

◆ ShowDefaultState()

◆ ShowExportValue()

◆ ShowFillColor()

◆ ShowFont()

◆ ShowFontSize()

◆ ShowLock()

◆ ShowName()

◆ ShowPrintability()

◆ ShowTextColor()

◆ ShowTextRotation()

◆ ShowTooltip()

◆ ShowVisibility()

◆ Type()

◆ UnsetBorder()

◆ UnsetBorderColor()

◆ UnsetBorderStyle()

◆ UnsetBorderThickness()

◆ UnsetDefaultState()

◆ UnsetEverything()

◆ UnsetExportValue()

◆ UnsetFillColor()

◆ UnsetFont()

◆ UnsetFontSize()

◆ UnsetLock()

◆ UnsetName()

◆ UnsetPrintability()

◆ UnsetTextColor()

◆ UnsetTextRotation()

◆ UnsetTooltip()

◆ UnsetVisibility()

Member Data Documentation

◆ staticType