HPS::Publish::DropDownListKit Class Reference

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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::DropDownListKit:

Collaboration diagram for HPS::Publish::DropDownListKit:

Public Member Functions
	DropDownListKit ()
	The default constructor creates an empty DropDownListKit object. More...
	DropDownListKit (DropDownListKit const &in_kit)
	The copy constructor creates a new DropDownListKit object that contains the same settings as the source DropDownListKit. More...
	DropDownListKit (DropDownListKit &&in_kit)
	The move constructor creates a DropDownListKit by transferring the underlying object of the rvalue reference to this DropDownListKit. More...
virtual	~DropDownListKit ()
HPS::Type	ObjectType () const
void	Set (DropDownListKit const &in_kit)
	Copies the source DropDownListKit into this DropDownListKit. More...
void	Show (DropDownListKit &out_kit) const
	Copies this DropDownListKit into the given DropDownListKit. More...
DropDownListKit &	operator= (DropDownListKit const &in_kit)
	Copies the source DropDownListKit into this DropDownListKit. More...
DropDownListKit &	operator= (DropDownListKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this DropDownListKit. More...
bool	Empty () const
	Indicates whether this DropDownListKit has any values set on it. More...
bool	Equals (DropDownListKit const &in_kit) const
	Check if the source DropDownListKit is equivalent to this DropDownListKit. More...
bool	operator== (DropDownListKit const &in_kit) const
	Check if the source DropDownListKit is equivalent to this DropDownListKit. More...
bool	operator!= (DropDownListKit const &in_kit) const
	Check if the source DropDownListKit is not equivalent to this DropDownListKit. More...
DropDownListKit &	SetName (char const *in_name)
	Sets the name of the drop down list. More...
DropDownListKit &	SetFont (Text::Font::Name in_name)
	Sets a builtin font for the drop down list. More...
DropDownListKit &	SetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular)
	Sets a specific font for the drop down list. More...
DropDownListKit &	SetFontSize (int in_size)
	Sets the font size for the drop down list. More...
DropDownListKit &	SetTextColor (RGBColor const &in_color)
	Sets the text color for the drop down list. More...
DropDownListKit &	SetTooltip (char const *in_tooltip)
	Sets the tooltip for the drop down list. More...
DropDownListKit &	SetVisibility (bool in_state)
	Sets the visibility for the drop down list. More...
DropDownListKit &	SetPrintability (bool in_state)
	Sets the printability for the drop down list. More...
DropDownListKit &	SetTextRotation (Text::Rotation in_rotation)
	Sets the text rotation for the drop down list. More...
DropDownListKit &	SetLock (bool in_state)
	Sets whether the drop down list is locked. More...
DropDownListKit &	SetBorder (bool in_state)
	Sets whether the drop down list has a border. More...
DropDownListKit &	SetBorderColor (RGBColor const &in_color)
	Sets the border color for the drop down list. More...
DropDownListKit &	SetBorderThickness (Border::Thickness in_thickness)
	Sets the border thickness for the drop down list. More...
DropDownListKit &	SetBorderStyle (Border::Style in_style)
	Sets the border style for the drop down list. More...
DropDownListKit &	SetFillColor (RGBColor const &in_color)
	Sets the fill color for the drop down list. More...
DropDownListKit &	SetCustomText (bool in_state)
	Sets whether the user can enter custom text. More...
DropDownListKit &	SetSpellChecking (bool in_state)
	Sets whether spell checking is enabled. More...
DropDownListKit &	SetImmediateCommit (bool in_state)
	Sets whether selected values are committed immediately. More...
DropDownListKit &	SetContents (UTF8Array const &in_displayed_values, UTF8Array const &in_export_values)
	Sets the contents of the drop down list. More...
DropDownListKit &	SetContents (size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[])
	Sets the contents of the drop down list. More...
DropDownListKit &	UnsetName ()
	Removes the name setting. More...
DropDownListKit &	UnsetFont ()
	Removes the font setting. More...
DropDownListKit &	UnsetFontSize ()
	Removes the font size setting. More...
DropDownListKit &	UnsetTextColor ()
	Removes the text color setting. More...
DropDownListKit &	UnsetTooltip ()
	Removes the tooltip setting. More...
DropDownListKit &	UnsetVisibility ()
	Removes the visibility setting. More...
DropDownListKit &	UnsetPrintability ()
	Removes the printability setting. More...
DropDownListKit &	UnsetTextRotation ()
	Removes the text rotation setting. More...
DropDownListKit &	UnsetLock ()
	Removes the lock setting. More...
DropDownListKit &	UnsetBorder ()
	Removes the border setting. More...
DropDownListKit &	UnsetBorderColor ()
	Removes the border color setting. More...
DropDownListKit &	UnsetBorderThickness ()
	Removes the border thickness setting. More...
DropDownListKit &	UnsetBorderStyle ()
	Removes the border style setting. More...
DropDownListKit &	UnsetFillColor ()
	Removes the fill color setting. More...
DropDownListKit &	UnsetCustomText ()
	Removes the custom text setting. More...
DropDownListKit &	UnsetSpellChecking ()
	Removes the spell checking setting. More...
DropDownListKit &	UnsetImmediateCommit ()
	Removes the immediate commit setting. More...
DropDownListKit &	UnsetContents ()
	Removes the content setting. More...
DropDownListKit &	UnsetEverything ()
	Removes all data from the drop down list. More...
bool	ShowName (UTF8 &out_name) const
	Shows the name for the drop down list. 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 drop down list. More...
bool	ShowFontSize (int &out_size) const
	Shows the font size for the drop down list. More...
bool	ShowTextColor (RGBColor &out_color) const
	Shows the text color for the drop down list. More...
bool	ShowTooltip (UTF8 &out_tooltip) const
	Shows the tooltip for the drop down list. More...
bool	ShowVisibility (bool &out_state) const
	Shows the visibility for the drop down list. More...
bool	ShowPrintability (bool &out_state) const
	Shows the printability for the drop down list. More...
bool	ShowTextRotation (Text::Rotation &out_rotation) const
	Shows the text rotation for the drop down list. More...
bool	ShowLock (bool &out_state) const
	Shows the lock setting for the drop down list. More...
bool	ShowBorder (bool &out_state) const
	Shows the border setting for the drop down list. More...
bool	ShowBorderColor (RGBColor &out_color) const
	Shows the border color for the drop down list. More...
bool	ShowBorderThickness (Border::Thickness &out_thickness) const
	Shows the border thickness for the drop down list. More...
bool	ShowBorderStyle (Border::Style &out_style) const
	Shows the border style for the drop down list. More...
bool	ShowFillColor (RGBColor &out_color) const
	Shows the fill color for the drop down list. More...
bool	ShowCustomText (bool &out_state) const
	Shows the custom text setting for the drop down list. More...
bool	ShowSpellChecking (bool &out_state) const
	Shows the spell checking setting for the drop down list. More...
bool	ShowImmediateCommit (bool &out_state) const
	Shows the immediate commit setting for the drop down list. More...
bool	ShowContents (UTF8Array &out_displayed_values, UTF8Array &out_export_values) const
	Shows the content setting for the drop down list. 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 DropDownListKit	GetDefault ()
	Creates a DropDownListKit 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::PublishDropDownListKit

Detailed Description

The DropDownListKit class is a user space object.

It acts as the container for all data that can be used to specify a drop down list for a Publish PDF.

Constructor & Destructor Documentation

DropDownListKit() [1/3]

HPS::Publish::DropDownListKit::DropDownListKit

(

)

The default constructor creates an empty DropDownListKit object.

DropDownListKit() [2/3]

HPS::Publish::DropDownListKit::DropDownListKit

(

DropDownListKit const &

in_kit

)

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

Parameters

in_kit

The source DropDownListKit to copy.

DropDownListKit() [3/3]

HPS::Publish::DropDownListKit::DropDownListKit

(

DropDownListKit &&

in_kit

)

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

Parameters

in_kit

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

~DropDownListKit()

virtual HPS::Publish::DropDownListKit::~DropDownListKit ( )

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::DropDownListKit::Empty ( ) const

virtual

Indicates whether this DropDownListKit has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::Publish::DropDownListKit::Equals

(

DropDownListKit const &

in_kit

)

const

Check if the source DropDownListKit is equivalent to this DropDownListKit.

Parameters

in_kit

The source DropDownListKit to compare to this DropDownListKit.

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 DropDownListKit HPS::Publish::DropDownListKit::GetDefault ( )

static

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

Returns

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::DropDownListKit::operator!=

(

DropDownListKit const &

in_kit

)

const

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

Parameters

in_kit

The source DropDownListKit to compare to this DropDownListKit.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

DropDownListKit& HPS::Publish::DropDownListKit::operator=

(

DropDownListKit const &

in_kit

)

Copies the source DropDownListKit into this DropDownListKit.

Parameters

in_kit

The source DropDownListKit to copy.

Returns

A reference to this DropDownListKit.

operator=() [2/2]

DropDownListKit& HPS::Publish::DropDownListKit::operator=

(

DropDownListKit &&

in_kit

)

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

Parameters

in_kit

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

Returns

A reference to this DropDownListKit.

operator==()

bool HPS::Publish::DropDownListKit::operator==

(

DropDownListKit const &

in_kit

)

const

Check if the source DropDownListKit is equivalent to this DropDownListKit.

Parameters

in_kit

The source DropDownListKit to compare to this DropDownListKit.

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

(

DropDownListKit const &

in_kit

)

Copies the source DropDownListKit into this DropDownListKit.

Parameters

in_kit

The source DropDownListKit to copy.

SetBorder()

DropDownListKit& HPS::Publish::DropDownListKit::SetBorder

(

bool

in_state

)

Sets whether the drop down list has a border.

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

Parameters

in_state

Whether the drop down list has a border.

Returns

A reference to this DropDownListKit.

SetBorderColor()

DropDownListKit& HPS::Publish::DropDownListKit::SetBorderColor

(

RGBColor const &

in_color

)

Sets the border color for the drop down list.

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

Parameters

in_color

The border color of the drop down list.

Returns

A reference to this DropDownListKit.

SetBorderStyle()

DropDownListKit& HPS::Publish::DropDownListKit::SetBorderStyle

(

Border::Style

in_style

)

Sets the border style for the drop down list.

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

Parameters

in_style

The border style for the drop down list.

Returns

A reference to this DropDownListKit.

SetBorderThickness()

DropDownListKit& HPS::Publish::DropDownListKit::SetBorderThickness

(

Border::Thickness

in_thickness

)

Sets the border thickness for the drop down list.

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

Parameters

in_thickness

The border thickness for the drop down list.

Returns

A reference to this DropDownListKit.

SetContents() [1/2]

DropDownListKit& HPS::Publish::DropDownListKit::SetContents	(	UTF8Array const &	in_displayed_values,
		UTF8Array const &	in_export_values
	)

Sets the contents of the drop down list.

This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem. The two arrays need to have the same size.

Parameters

in_displayed_values	The values displayed in the drop down list
in_export_values	The export values associated with the values displayed

Returns

A reference to this DropDownListKit.

SetContents() [2/2]

DropDownListKit& HPS::Publish::DropDownListKit::SetContents	(	size_t	in_count,
		UTF8 const	in_displayed_values[],
		UTF8 const	in_export_values[]
	)

Sets the contents of the drop down list.

This corresponds to the value that will be passed to A3DPDFPageFieldListAddItem.

Parameters

in_count	The size of the arrays passed in.
in_displayed_values	The values displayed in the drop down list
in_export_values	The export values associated with the values displayed

Returns

A reference to this DropDownListKit.

SetCustomText()

DropDownListKit& HPS::Publish::DropDownListKit::SetCustomText

(

bool

in_state

)

Sets whether the user can enter custom text.

This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bAllowUserToEnterCustomText.

Parameters

in_state

Whether the user can enter custom text.

Returns

A reference to this DropDownListKit.

SetFillColor()

DropDownListKit& HPS::Publish::DropDownListKit::SetFillColor

(

RGBColor const &

in_color

)

Sets the fill color for the drop down list.

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

Parameters

in_color

The fill color for the drop down list.

Returns

A reference to this DropDownListKit.

SetFont() [1/2]

DropDownListKit& HPS::Publish::DropDownListKit::SetFont

(

Text::Font::Name

in_name

)

Sets a builtin font for the drop down list.

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

Parameters

in_name

The builtin font for the drop down list.

Returns

A reference to this DropDownListKit.

SetFont() [2/2]

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

Sets a specific font for the drop down list.

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

Parameters

in_name	UTF8-encoded font name for the drop down list.
in_style	The style of font to use for the drop down list.

Returns

A reference to this DropDownListKit.

SetFontSize()

DropDownListKit& HPS::Publish::DropDownListKit::SetFontSize

(

int

in_size

)

Sets the font size for the drop down list.

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

Parameters

in_size

The font size for the drop down list.

Returns

A reference to this DropDownListKit.

SetImmediateCommit()

DropDownListKit& HPS::Publish::DropDownListKit::SetImmediateCommit

(

bool

in_state

)

Sets whether selected values are committed immediately.

This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCommitImmediate.

Parameters

in_state

Whether selected values are committed immediately.

Returns

A reference to this DropDownListKit.

SetLock()

DropDownListKit& HPS::Publish::DropDownListKit::SetLock

(

bool

in_state

)

Sets whether the drop down list is locked.

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

Parameters

in_state

Whether the drop down list is locked.

Returns

A reference to this DropDownListKit.

SetName()

DropDownListKit& HPS::Publish::DropDownListKit::SetName

(

char const *

in_name

)

Sets the name of the drop down list.

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

Parameters

in_name

UTF8-encoded name of the drop down list.

Returns

A reference to this DropDownListKit.

SetPrintability()

DropDownListKit& HPS::Publish::DropDownListKit::SetPrintability

(

bool

in_state

)

Sets the printability for the drop down list.

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

Parameters

in_state

The printability for the drop down list.

Returns

A reference to this DropDownListKit.

SetSpellChecking()

DropDownListKit& HPS::Publish::DropDownListKit::SetSpellChecking

(

bool

in_state

)

Sets whether spell checking is enabled.

This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCheckSpelling.

Parameters

in_state

Whether spell checking is enabled.

Returns

A reference to this DropDownListKit.

SetTextColor()

DropDownListKit& HPS::Publish::DropDownListKit::SetTextColor

(

RGBColor const &

in_color

)

Sets the text color for the drop down list.

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

Parameters

in_color

The text color for the drop down list.

Returns

A reference to this DropDownListKit.

SetTextRotation()

DropDownListKit& HPS::Publish::DropDownListKit::SetTextRotation

(

Text::Rotation

in_rotation

)

Sets the text rotation for the drop down list.

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

Parameters

in_rotation

The text rotation for the drop down list.

Returns

A reference to this DropDownListKit.

SetTooltip()

DropDownListKit& HPS::Publish::DropDownListKit::SetTooltip

(

char const *

in_tooltip

)

Sets the tooltip for the drop down list.

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

Parameters

in_tooltip

UTF8-encoded tooltip text for the drop down list.

Returns

A reference to this DropDownListKit.

SetVisibility()

DropDownListKit& HPS::Publish::DropDownListKit::SetVisibility

(

bool

in_state

)

Sets the visibility for the drop down list.

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

Parameters

in_state

The visibility for the drop down list.

Returns

A reference to this DropDownListKit.

Show()

void HPS::Publish::DropDownListKit::Show

(

DropDownListKit &

out_kit

)

const

Copies this DropDownListKit into the given DropDownListKit.

Parameters

out_kit

The DropDownListKit to populate with the contents of this DropDownListKit.

ShowBorder()

bool HPS::Publish::DropDownListKit::ShowBorder

(

bool &

out_state

)

const

Shows the border setting for the drop down list.

Parameters

out_state

Whether the drop down list has a border.

Returns

true if a border setting was specified, false otherwise.

ShowBorderColor()

bool HPS::Publish::DropDownListKit::ShowBorderColor

(

RGBColor &

out_color

)

const

Shows the border color for the drop down list.

Parameters

out_color

The border color of the drop down list.

Returns

true if a border color was specified, false otherwise.

ShowBorderStyle()

bool HPS::Publish::DropDownListKit::ShowBorderStyle

(

Border::Style &

out_style

)

const

Shows the border style for the drop down list.

Parameters

out_style

The border style for the drop down list.

Returns

true if a border style was specified, false otherwise.

ShowBorderThickness()

bool HPS::Publish::DropDownListKit::ShowBorderThickness

(

Border::Thickness &

out_thickness

)

const

Shows the border thickness for the drop down list.

Parameters

out_thickness

The border thickness for the drop down list.

Returns

true if a border thickness was specified, false otherwise.

ShowContents()

bool HPS::Publish::DropDownListKit::ShowContents	(	UTF8Array &	out_displayed_values,
		UTF8Array &	out_export_values
	)		const

Shows the content setting for the drop down list.

Parameters

out_displayed_values	The values displayed by the drop down list
out_export_values	The export values associated with the displayed values.

Returns

true if a content setting was specified, false otherwise.

ShowCustomText()

bool HPS::Publish::DropDownListKit::ShowCustomText

(

bool &

out_state

)

const

Shows the custom text setting for the drop down list.

Parameters

out_state

Whether the user can enter custom text.

Returns

true if a custom text setting was specified, false otherwise.

ShowFillColor()

bool HPS::Publish::DropDownListKit::ShowFillColor

(

RGBColor &

out_color

)

const

Shows the fill color for the drop down list.

Parameters

out_color

The fill color for the drop down list.

Returns

true if a fill color was specified, false otherwise.

ShowFont()

bool HPS::Publish::DropDownListKit::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 drop down list.

Parameters

out_type	The type of font for the drop down list.
out_font	The built-in font for the drop down list. This is only valid if out_type is Text::Font::Type::BuiltIn.
out_font_name	The explicit font name for the drop down list. This is only valid if out_type is Text::Font::Type::Explicit.
out_style	The font style for the drop down list. 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::DropDownListKit::ShowFontSize

(

int &

out_size

)

const

Shows the font size for the drop down list.

Parameters

out_size

The font size for the drop down list.

Returns

true if a font size was specified, false otherwise.

ShowImmediateCommit()

bool HPS::Publish::DropDownListKit::ShowImmediateCommit

(

bool &

out_state

)

const

Shows the immediate commit setting for the drop down list.

Parameters

out_state

Whether selected values are committed immediately.

Returns

true if an immediate commit setting was specified, false otherwise.

ShowLock()

bool HPS::Publish::DropDownListKit::ShowLock

(

bool &

out_state

)

const

Shows the lock setting for the drop down list.

Parameters

in_state

Whether the drop down list is locked.

Returns

true if a lock setting was specified, false otherwise.

ShowName()

bool HPS::Publish::DropDownListKit::ShowName

(

UTF8 &

out_name

)

const

Shows the name for the drop down list.

Parameters

out_name

The name of the drop down list.

Returns

true if a name was specified, false otherwise.

ShowPrintability()

bool HPS::Publish::DropDownListKit::ShowPrintability

(

bool &

out_state

)

const

Shows the printability for the drop down list.

Parameters

out_state

The printability for the drop down list.

Returns

true if a printability was specified, false otherwise.

ShowSpellChecking()

bool HPS::Publish::DropDownListKit::ShowSpellChecking

(

bool &

out_state

)

const

Shows the spell checking setting for the drop down list.

Parameters

out_state

Whether spell checking is enabled.

Returns

true if a spell checking setting was specified, false otherwise.

ShowTextColor()

bool HPS::Publish::DropDownListKit::ShowTextColor

(

RGBColor &

out_color

)

const

Shows the text color for the drop down list.

Parameters

out_color

The text color for the drop down list.

Returns

true if a text color was specified, false otherwise.

ShowTextRotation()

bool HPS::Publish::DropDownListKit::ShowTextRotation

(

Text::Rotation &

out_rotation

)

const

Shows the text rotation for the drop down list.

Parameters

out_rotation

The text rotation for the drop down list.

Returns

true if a rotation was specified, false otherwise.

ShowTooltip()

bool HPS::Publish::DropDownListKit::ShowTooltip

(

UTF8 &

out_tooltip

)

const

Shows the tooltip for the drop down list.

Parameters

out_tooltip

The tooltip text for the drop down list.

Returns

true if a tooltip was specified, false otherwise.

ShowVisibility()

bool HPS::Publish::DropDownListKit::ShowVisibility

(

bool &

out_state

)

const

Shows the visibility for the drop down list.

Parameters

out_state

The visibility for the drop down list.

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()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetBorder

(

)

Removes the border setting.

Returns

A reference to this DropDownListKit.

UnsetBorderColor()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetBorderColor

(

)

Removes the border color setting.

Returns

A reference to this DropDownListKit.

UnsetBorderStyle()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetBorderStyle

(

)

Removes the border style setting.

Returns

A reference to this DropDownListKit.

UnsetBorderThickness()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetBorderThickness

(

)

Removes the border thickness setting.

Returns

A reference to this DropDownListKit.

UnsetContents()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetContents

(

)

Removes the content setting.

Returns

A reference to this DropDownListKit.

UnsetCustomText()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetCustomText

(

)

Removes the custom text setting.

Returns

A reference to this DropDownListKit.

UnsetEverything()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetEverything

(

)

Removes all data from the drop down list.

Returns

A reference to this DropDownListKit.

UnsetFillColor()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetFillColor

(

)

Removes the fill color setting.

Returns

A reference to this DropDownListKit.

UnsetFont()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetFont

(

)

Removes the font setting.

Returns

A reference to this DropDownListKit.

UnsetFontSize()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetFontSize

(

)

Removes the font size setting.

Returns

A reference to this DropDownListKit.

UnsetImmediateCommit()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetImmediateCommit

(

)

Removes the immediate commit setting.

Returns

A reference to this DropDownListKit.

UnsetLock()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetLock

(

)

Removes the lock setting.

Returns

A reference to this DropDownListKit.

UnsetName()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetName

(

)

Removes the name setting.

Returns

A reference to this DropDownListKit.

UnsetPrintability()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetPrintability

(

)

Removes the printability setting.

Returns

A reference to this DropDownListKit.

UnsetSpellChecking()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetSpellChecking

(

)

Removes the spell checking setting.

Returns

A reference to this DropDownListKit.

UnsetTextColor()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetTextColor

(

)

Removes the text color setting.

Returns

A reference to this DropDownListKit.

UnsetTextRotation()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetTextRotation

(

)

Removes the text rotation setting.

Returns

A reference to this DropDownListKit.

UnsetTooltip()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetTooltip

(

)

Removes the tooltip setting.

Returns

A reference to this DropDownListKit.

UnsetVisibility()

DropDownListKit& HPS::Publish::DropDownListKit::UnsetVisibility

(

)

Removes the visibility setting.

Returns

A reference to this DropDownListKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::DropDownListKit::staticType = HPS::Type::PublishDropDownListKit

static

---

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

• sprk_publish.h