HPS::Publish::ButtonKit Class Reference

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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ButtonKit:

Collaboration diagram for HPS::Publish::ButtonKit:

Public Member Functions
	ButtonKit ()
	The default constructor creates an empty ButtonKit object. More...
	ButtonKit (ButtonKit const &in_kit)
	The copy constructor creates a new ButtonKit object that contains the same settings as the source ButtonKit. More...
	ButtonKit (ButtonKit &&in_kit)
	The move constructor creates a ButtonKit by transferring the underlying object of the rvalue reference to this ButtonKit. More...
virtual	~ButtonKit ()
HPS::Type	ObjectType () const
void	Set (ButtonKit const &in_kit)
	Copies the source ButtonKit into this ButtonKit. More...
void	Show (ButtonKit &out_kit) const
	Copies this ButtonKit into the given ButtonKit. More...
ButtonKit &	operator= (ButtonKit const &in_kit)
	Copies the source ButtonKit into this ButtonKit. More...
ButtonKit &	operator= (ButtonKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this ButtonKit. More...
bool	Empty () const
	Indicates whether this ButtonKit has any values set on it. More...
bool	Equals (ButtonKit const &in_kit) const
	Check if the source ButtonKit is equivalent to this ButtonKit. More...
bool	operator== (ButtonKit const &in_kit) const
	Check if the source ButtonKit is equivalent to this ButtonKit. More...
bool	operator!= (ButtonKit const &in_kit) const
	Check if the source ButtonKit is not equivalent to this ButtonKit. More...
ButtonKit &	SetName (char const *in_name)
	Sets the name of the button. More...
ButtonKit &	SetLabel (char const *in_label)
	Sets the label for the button. More...
ButtonKit &	SetFont (Text::Font::Name in_name)
	Sets a builtin font for the button. More...
ButtonKit &	SetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
	Sets a specific font for the button. More...
ButtonKit &	SetFontSize (int in_size)
	Sets the font size for the button. More...
ButtonKit &	SetTextColor (RGBColor const &in_color)
	Sets the text color for the button. More...
ButtonKit &	SetTooltip (char const *in_tooltip)
	Sets the tooltip for the button. More...
ButtonKit &	SetVisibility (bool in_state)
	Sets the visibility for the button. More...
ButtonKit &	SetPrintability (bool in_state)
	Sets the printability for the button. More...
ButtonKit &	SetTextRotation (Text::Rotation in_rotation)
	Sets the text rotation for the button. More...
ButtonKit &	SetLock (bool in_state)
	Sets whether the button is locked. More...
ButtonKit &	SetBorder (bool in_state)
	Sets whether the button has a border. More...
ButtonKit &	SetBorderColor (RGBColor const &in_color)
	Sets the border color for the button. More...
ButtonKit &	SetBorderThickness (Border::Thickness in_thickness)
	Sets the border thickness for the button. More...
ButtonKit &	SetBorderStyle (Border::Style in_style)
	Sets the border style for the button. More...
ButtonKit &	SetFillColor (RGBColor const &in_color)
	Sets the fill color for the button. More...
ButtonKit &	SetLabelPosition (Label::Position in_position)
	Sets the label position for the button. More...
ButtonKit &	SetHighlighting (Highlighting::Mode in_mode)
	Sets the highlighting mode for the button. More...
ButtonKit &	SetIconImage (ImageKit const &in_image)
	Sets the icon image for the button. More...
ButtonKit &	UnsetName ()
	Removes the name setting. More...
ButtonKit &	UnsetLabel ()
	Removes the label setting. More...
ButtonKit &	UnsetFont ()
	Removes the font setting. More...
ButtonKit &	UnsetFontSize ()
	Removes the font size setting. More...
ButtonKit &	UnsetTextColor ()
	Removes the text color setting. More...
ButtonKit &	UnsetTooltip ()
	Removes the tooltip setting. More...
ButtonKit &	UnsetVisibility ()
	Removes the visibility setting. More...
ButtonKit &	UnsetPrintability ()
	Removes the printability setting. More...
ButtonKit &	UnsetTextRotation ()
	Removes the text rotation setting. More...
ButtonKit &	UnsetLock ()
	Removes the lock setting. More...
ButtonKit &	UnsetBorder ()
	Removes the border setting. More...
ButtonKit &	UnsetBorderColor ()
	Removes the border color setting. More...
ButtonKit &	UnsetBorderThickness ()
	Removes the border thickness setting. More...
ButtonKit &	UnsetBorderStyle ()
	Removes the border style setting. More...
ButtonKit &	UnsetFillColor ()
	Removes the fill color setting. More...
ButtonKit &	UnsetLabelPosition ()
	Removes the label position setting. More...
ButtonKit &	UnsetHighlighting ()
	Removes the highlighting mode setting. More...
ButtonKit &	UnsetIconImage ()
	Removes the icon image setting. More...
ButtonKit &	UnsetEverything ()
	Removes all data from the button. More...
bool	ShowName (UTF8 &out_name) const
	Shows the name for the button. More...
bool	ShowLabel (UTF8 &out_label) const
	Shows the label for the button. 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 button. More...
bool	ShowFontSize (int &out_size) const
	Shows the font size for the button. More...
bool	ShowTextColor (RGBColor &out_color) const
	Shows the text color for the button. More...
bool	ShowTooltip (UTF8 &out_tooltip) const
	Shows the tooltip for the button. More...
bool	ShowVisibility (bool &out_state) const
	Shows the visibility for the button. More...
bool	ShowPrintability (bool &out_state) const
	Shows the printability for the button. More...
bool	ShowTextRotation (Text::Rotation &out_rotation) const
	Shows the text rotation for the button. More...
bool	ShowLock (bool &out_state) const
	Shows the lock setting for the button. More...
bool	ShowBorder (bool &out_state) const
	Shows the border setting for the button. More...
bool	ShowBorderColor (RGBColor &out_color) const
	Shows the border color for the button. More...
bool	ShowBorderThickness (Border::Thickness &out_thickness) const
	Shows the border thickness for the button. More...
bool	ShowBorderStyle (Border::Style &out_style) const
	Shows the border style for the button. More...
bool	ShowFillColor (RGBColor &out_color) const
	Shows the fill color for the button. More...
bool	ShowLabelPosition (Label::Position &out_position) const
	Shows the label position for the button. More...
bool	ShowHighlighting (Highlighting::Mode &out_mode) const
	Shows the highlighting mode for the button. More...
bool	ShowIconImage (ImageKit &out_image) const
	Shows the icon image for the button. 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 ButtonKit	GetDefault ()
	Creates a ButtonKit 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::PublishButtonKit

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_kit

The 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_kit

An rvalue reference to a ButtonKit to take the underlying object from.

~ButtonKit()

virtual HPS::Publish::ButtonKit::~ButtonKit ( )

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::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_kit

The source ButtonKit to compare to this ButtonKit.

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 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.

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::ButtonKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::ButtonKit::operator!=

(

ButtonKit const &

in_kit

)

const

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

Parameters

in_kit

The 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_kit

The 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_kit

An 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_kit

The source ButtonKit to compare to this ButtonKit.

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::ButtonKit::Set

(

ButtonKit const &

in_kit

)

Copies the source ButtonKit into this ButtonKit.

Parameters

in_kit

The 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_state

Whether 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_color

The 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_style

The 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_thickness

The 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_color

The 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_name

The 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_name	UTF8-encoded font name for the button.
in_style	The 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_size

The 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_mode

The 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_image

The 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_label

UTF8-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_position

The 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_state

Whether 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_name

UTF8-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_state

The 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_color

The 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_rotation

The 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_tooltip

UTF8-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_state

The 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_kit

The 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_state

Whether 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_color

The 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_style

The 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_thickness

The 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_color

The 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_type	The type of font for the button.
out_font	The built-in font for the button. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_name	The explicit font name for the button. This is only valid if out_type is Text::Font::Type::Explicit.
out_style	The 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_size

The 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_mode

The 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_image

The 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_label

The 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_position

The 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_state

Whether 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_name

The 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_state

The 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_color

The 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_rotation

The 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_tooltip

The 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_state

The visibility for the button.

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.

Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

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.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::ButtonKit::staticType = HPS::Type::PublishButtonKit

static

---

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

• sprk_publish.h