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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ListBoxKit:

Collaboration diagram for HPS::Publish::ListBoxKit:

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

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

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

virtual	~ListBoxKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

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

ListBoxKit &	SetName (char const *in_name)
	Sets the name of the list box. More...

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

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

ListBoxKit &	SetFontSize (int in_size)
	Sets the font size for the list box. More...

ListBoxKit &	SetTextColor (RGBColor const &in_color)
	Sets the text color for the list box. More...

ListBoxKit &	SetTooltip (char const *in_tooltip)
	Sets the tooltip for the list box. More...

ListBoxKit &	SetVisibility (bool in_state)
	Sets the visibility for the list box. More...

ListBoxKit &	SetPrintability (bool in_state)
	Sets the printability for the list box. More...

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

ListBoxKit &	SetLock (bool in_state)
	Sets whether the list box is locked. More...

ListBoxKit &	SetBorder (bool in_state)
	Sets whether the list box has a border. More...

ListBoxKit &	SetBorderColor (RGBColor const &in_color)
	Sets the border color for the list box. More...

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

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

ListBoxKit &	SetFillColor (RGBColor const &in_color)
	Sets the fill color for the list box. More...

ListBoxKit &	SetMultipleSelection (bool in_state)
	Sets whether multiple selection is allowed. More...

ListBoxKit &	SetContents (UTF8Array const &in_displayed_values, UTF8Array const &in_export_values)
	Sets the contents of the list box. More...

ListBoxKit &	SetContents (size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[])
	Sets the contents of the list box. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ListBoxKit &	UnsetMultipleSelection ()
	Removes the multiple selection setting. More...

ListBoxKit &	UnsetContents ()
	Removes the content setting. More...

ListBoxKit &	UnsetEverything ()
	Removes all data from the list box. More...

bool	ShowName (UTF8 &out_name) const
	Shows the name for the list 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 list box. More...

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

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

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

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

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

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

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

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

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

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

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

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

bool	ShowMultipleSelection (bool &out_state) const
	Shows the multiple selection setting for the list box. More...

bool	ShowContents (UTF8Array &out_displayed_values, UTF8Array &out_export_values) const
	Shows the content setting for the list 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 ListBoxKit	GetDefault ()
	Creates a ListBoxKit 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::PublishListBoxKit

Detailed Description

The ListBoxKit class is a user space object.

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

Constructor & Destructor Documentation

◆ ListBoxKit() [1/3]

HPS::Publish::ListBoxKit::ListBoxKit ( )

The default constructor creates an empty ListBoxKit object.

◆ ListBoxKit() [2/3]

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

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

Parameters

in_kit The source ListBoxKit to copy.

◆ ListBoxKit() [3/3]

HPS::Publish::ListBoxKit::ListBoxKit ( ListBoxKit && in_kit )

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

Parameters

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

◆ ~ListBoxKit()

virtual HPS::Publish::ListBoxKit::~ListBoxKit ( )

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

virtual

Indicates whether this ListBoxKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ListBoxKit is equivalent to this ListBoxKit.

Parameters

in_kit The source ListBoxKit to compare to this ListBoxKit.

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

static

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

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source ListBoxKit to compare to this ListBoxKit.

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

◆ operator=() [1/2]

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

Copies the source ListBoxKit into this ListBoxKit.

Parameters

in_kit The source ListBoxKit to copy.

Returns: A reference to this ListBoxKit.

◆ operator=() [2/2]

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

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

Parameters

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

Returns: A reference to this ListBoxKit.

◆ operator==()

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

Check if the source ListBoxKit is equivalent to this ListBoxKit.

Parameters

in_kit The source ListBoxKit to compare to this ListBoxKit.

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::ListBoxKit::Set ( ListBoxKit const & in_kit )

Copies the source ListBoxKit into this ListBoxKit.

Parameters

in_kit The source ListBoxKit to copy.

◆ SetBorder()

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

Sets whether the list box has a border.

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

Parameters

in_state Whether the list box has a border.

Returns: A reference to this ListBoxKit.

◆ SetBorderColor()

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

Sets the border color for the list box.

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

Parameters

in_color The border color of the list box.

Returns: A reference to this ListBoxKit.

◆ SetBorderStyle()

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

Sets the border style for the list box.

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

Parameters

in_style The border style for the list box.

Returns: A reference to this ListBoxKit.

◆ SetBorderThickness()

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

Sets the border thickness for the list box.

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

Parameters

in_thickness The border thickness for the list box.

Returns: A reference to this ListBoxKit.

◆ SetContents() [1/2]

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

Sets the contents of the list box.

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 list box
in_export_values	The export values associated with the values displayed

Returns: A reference to this ListBoxKit.

◆ SetContents() [2/2]

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

Sets the contents of the list box.

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 list box
in_export_values	The export values associated with the values displayed

Returns: A reference to this ListBoxKit.

◆ SetFillColor()

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

Sets the fill color for the list box.

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

Parameters

in_color The fill color for the list box.

Returns: A reference to this ListBoxKit.

◆ SetFont() [1/2]

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

Sets a builtin font for the list box.

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

Parameters

in_name The builtin font for the list box.

Returns: A reference to this ListBoxKit.

◆ SetFont() [2/2]

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

Sets a specific font for the list box.

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

Parameters

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

Returns: A reference to this ListBoxKit.

◆ SetFontSize()

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

Sets the font size for the list box.

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

Parameters

in_size The font size for the list box.

Returns: A reference to this ListBoxKit.

◆ SetLock()

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

Sets whether the list box is locked.

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

Parameters

in_state Whether the list box is locked.

Returns: A reference to this ListBoxKit.

◆ SetMultipleSelection()

ListBoxKit& HPS::Publish::ListBoxKit::SetMultipleSelection ( bool in_state )

Sets whether multiple selection is allowed.

This corresponds to the value that will be passed to A3DPDFListBoxData::m_bMultipleSelection.

Parameters

in_state Whether multiple selection is allowed

Returns: A reference to this ListBoxKit.

◆ SetName()

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

Sets the name of the list box.

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

Parameters

in_name UTF8-encoded name of the list box.

Returns: A reference to this ListBoxKit.

◆ SetPrintability()

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

Sets the printability for the list box.

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

Parameters

in_state The printability for the list box.

Returns: A reference to this ListBoxKit.

◆ SetTextColor()

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

Sets the text color for the list box.

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

Parameters

in_color The text color for the list box.

Returns: A reference to this ListBoxKit.

◆ SetTextRotation()

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

Sets the text rotation for the list box.

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

Parameters

in_rotation The text rotation for the list box.

Returns: A reference to this ListBoxKit.

◆ SetTooltip()

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

Sets the tooltip for the list box.

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

Parameters

in_tooltip UTF8-encoded tooltip text for the list box.

Returns: A reference to this ListBoxKit.

◆ SetVisibility()

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

Sets the visibility for the list box.

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

Parameters

in_state The visibility for the list box.

Returns: A reference to this ListBoxKit.

◆ Show()

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

Copies this ListBoxKit into the given ListBoxKit.

Parameters

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

◆ ShowBorder()

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

Shows the border setting for the list box.

Parameters

out_state Whether the list box has a border.

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

◆ ShowBorderColor()

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

Shows the border color for the list box.

Parameters

out_color The border color of the list box.

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

◆ ShowBorderStyle()

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

Shows the border style for the list box.

Parameters

out_style The border style for the list box.

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

◆ ShowBorderThickness()

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

Shows the border thickness for the list box.

Parameters

out_thickness The border thickness for the list box.

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

◆ ShowContents()

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

Shows the content setting for the list box.

Parameters

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

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

◆ ShowFillColor()

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

Shows the fill color for the list box.

Parameters

out_color The fill color for the list box.

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

◆ ShowFont()

bool HPS::Publish::ListBoxKit::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 list box.

Parameters

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

Shows the font size for the list box.

Parameters

out_size The font size for the list box.

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

◆ ShowLock()

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

Shows the lock setting for the list box.

Parameters

in_state Whether the list box is locked.

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

◆ ShowMultipleSelection()

bool HPS::Publish::ListBoxKit::ShowMultipleSelection ( bool & out_state ) const

Shows the multiple selection setting for the list box.

Parameters

out_state Whether multiple selection is enabled.

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

◆ ShowName()

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

Shows the name for the list box.

Parameters

out_name The name of the list box.

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

◆ ShowPrintability()

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

Shows the printability for the list box.

Parameters

out_state The printability for the list box.

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

◆ ShowTextColor()

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

Shows the text color for the list box.

Parameters

out_color The text color for the list box.

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

◆ ShowTextRotation()

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

Shows the text rotation for the list box.

Parameters

out_rotation The text rotation for the list box.

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

◆ ShowTooltip()

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

Shows the tooltip for the list box.

Parameters

out_tooltip The tooltip text for the list box.

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

◆ ShowVisibility()

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

Shows the visibility for the list box.

Parameters

out_state The visibility for the list 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()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorder ( )

Removes the border setting.

Returns: A reference to this ListBoxKit.

◆ UnsetBorderColor()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderColor ( )

Removes the border color setting.

Returns: A reference to this ListBoxKit.

◆ UnsetBorderStyle()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns: A reference to this ListBoxKit.

◆ UnsetBorderThickness()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns: A reference to this ListBoxKit.

◆ UnsetContents()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetContents ( )

Removes the content setting.

Returns: A reference to this ListBoxKit.

◆ UnsetEverything()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetEverything ( )

Removes all data from the list box.

Returns: A reference to this ListBoxKit.

◆ UnsetFillColor()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetFillColor ( )

Removes the fill color setting.

Returns: A reference to this ListBoxKit.

◆ UnsetFont()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetFont ( )

Removes the font setting.

Returns: A reference to this ListBoxKit.

◆ UnsetFontSize()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetFontSize ( )

Removes the font size setting.

Returns: A reference to this ListBoxKit.

◆ UnsetLock()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetLock ( )

Removes the lock setting.

Returns: A reference to this ListBoxKit.

◆ UnsetMultipleSelection()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetMultipleSelection ( )

Removes the multiple selection setting.

Returns: A reference to this ListBoxKit.

◆ UnsetName()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetName ( )

Removes the name setting.

Returns: A reference to this ListBoxKit.

◆ UnsetPrintability()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetPrintability ( )

Removes the printability setting.

Returns: A reference to this ListBoxKit.

◆ UnsetTextColor()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetTextColor ( )

Removes the text color setting.

Returns: A reference to this ListBoxKit.

◆ UnsetTextRotation()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns: A reference to this ListBoxKit.

◆ UnsetTooltip()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns: A reference to this ListBoxKit.

◆ UnsetVisibility()

ListBoxKit& HPS::Publish::ListBoxKit::UnsetVisibility ( )

Removes the visibility setting.

Returns: A reference to this ListBoxKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Publish::ListBoxKit::staticType = HPS::Type::PublishListBoxKit

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

◆ ListBoxKit() [1/3]

◆ ListBoxKit() [2/3]

◆ ListBoxKit() [3/3]

◆ ~ListBoxKit()

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

◆ SetContents() [1/2]

◆ SetContents() [2/2]

◆ SetFillColor()

◆ SetFont() [1/2]

◆ SetFont() [2/2]

◆ SetFontSize()

◆ SetLock()

◆ SetMultipleSelection()

◆ SetName()

◆ SetPrintability()

◆ SetTextColor()

◆ SetTextRotation()

◆ SetTooltip()

◆ SetVisibility()

◆ Show()

◆ ShowBorder()

◆ ShowBorderColor()

◆ ShowBorderStyle()

◆ ShowBorderThickness()

◆ ShowContents()

◆ ShowFillColor()

◆ ShowFont()

◆ ShowFontSize()

◆ ShowLock()

◆ ShowMultipleSelection()

◆ ShowName()

◆ ShowPrintability()

◆ ShowTextColor()

◆ ShowTextRotation()

◆ ShowTooltip()

◆ ShowVisibility()

◆ Type()

◆ UnsetBorder()

◆ UnsetBorderColor()

◆ UnsetBorderStyle()

◆ UnsetBorderThickness()

◆ UnsetContents()

◆ UnsetEverything()

◆ UnsetFillColor()

◆ UnsetFont()

◆ UnsetFontSize()

◆ UnsetLock()

◆ UnsetMultipleSelection()

◆ UnsetName()

◆ UnsetPrintability()

◆ UnsetTextColor()

◆ UnsetTextRotation()

◆ UnsetTooltip()

◆ UnsetVisibility()

Member Data Documentation

◆ staticType