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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::TextFieldKit:

Collaboration diagram for HPS::Publish::TextFieldKit:

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

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

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

virtual	~TextFieldKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

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

TextFieldKit &	SetName (char const *in_name)
	Sets the name of the text field. More...

TextFieldKit &	SetFont (Text::Font::Name in_name)
	Sets a builtin font for the text field. More...

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

TextFieldKit &	SetFontSize (int in_size)
	Sets the font size for the text field. More...

TextFieldKit &	SetTextColor (RGBColor const &in_color)
	Sets the text color for the text field. More...

TextFieldKit &	SetTooltip (char const *in_tooltip)
	Sets the tooltip for the text field. More...

TextFieldKit &	SetVisibility (bool in_state)
	Sets the visibility for the text field. More...

TextFieldKit &	SetPrintability (bool in_state)
	Sets the printability for the text field. More...

TextFieldKit &	SetTextRotation (Text::Rotation in_rotation)
	Sets the text rotation for the text field. More...

TextFieldKit &	SetLock (bool in_state)
	Sets whether the text field is locked. More...

TextFieldKit &	SetBorder (bool in_state)
	Sets whether the text field has a border. More...

TextFieldKit &	SetBorderColor (RGBColor const &in_color)
	Sets the border color for the text field. More...

TextFieldKit &	SetBorderThickness (Border::Thickness in_thickness)
	Sets the border thickness for the text field. More...

TextFieldKit &	SetBorderStyle (Border::Style in_style)
	Sets the border style for the text field. More...

TextFieldKit &	SetFillColor (RGBColor const &in_color)
	Sets the fill color for the text field. More...

TextFieldKit &	SetDefaultValue (char const *in_value)
	Sets the default value for the text field. More...

TextFieldKit &	SetTextJustification (HPS::Text::Justification in_justification)
	Sets the text justification for the text field. More...

TextFieldKit &	SetMultiline (bool in_state)
	Sets whether the text field is multiline. More...

TextFieldKit &	SetScrolling (bool in_state)
	Sets whether the text field can scroll. More...

TextFieldKit &	SetReadOnly (bool in_state)
	Sets whether the text field is read only. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TextFieldKit &	UnsetDefaultValue ()
	Removes the default value setting. More...

TextFieldKit &	UnsetTextJustification ()
	Removes the text justification setting. More...

TextFieldKit &	UnsetMultiline ()
	Removes the multiline setting. More...

TextFieldKit &	UnsetScrolling ()
	Removes the scrolling setting. More...

TextFieldKit &	UnsetReadOnly ()
	Removes the read-only setting. More...

TextFieldKit &	UnsetEverything ()
	Removes all data from the text field. More...

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

bool	ShowFontSize (int &out_size) const
	Shows the font size for the text field. More...

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

bool	ShowTooltip (UTF8 &out_tooltip) const
	Shows the tooltip for the text field. More...

bool	ShowVisibility (bool &out_state) const
	Shows the visibility for the text field. More...

bool	ShowPrintability (bool &out_state) const
	Shows the printability for the text field. More...

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

bool	ShowLock (bool &out_state) const
	Shows the lock setting for the text field. More...

bool	ShowBorder (bool &out_state) const
	Shows the border setting for the text field. More...

bool	ShowBorderColor (RGBColor &out_color) const
	Shows the border color for the text field. More...

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

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

bool	ShowFillColor (RGBColor &out_color) const
	Shows the fill color for the text field. More...

bool	ShowDefaultValue (UTF8 &out_value) const
	Shows the default value for the text field. More...

bool	ShowTextJustification (HPS::Text::Justification &out_justification) const
	Shows the text justification for the text field. More...

bool	ShowMultiline (bool &out_state) const
	Shows the multiline setting for the text field. More...

bool	ShowScrolling (bool &out_state) const
	Shows the scrolling setting for the text field. More...

bool	ShowReadOnly (bool &out_state) const
	Shows the read-only setting for the text field. 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 TextFieldKit	GetDefault ()
	Creates a TextFieldKit 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::PublishTextFieldKit

Detailed Description

The TextFieldKit class is a user space object.

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

Constructor & Destructor Documentation

◆ TextFieldKit() [1/3]

HPS::Publish::TextFieldKit::TextFieldKit ( )

The default constructor creates an empty TextFieldKit object.

◆ TextFieldKit() [2/3]

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

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

Parameters

in_kit The source TextFieldKit to copy.

◆ TextFieldKit() [3/3]

HPS::Publish::TextFieldKit::TextFieldKit ( TextFieldKit && in_kit )

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

Parameters

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

◆ ~TextFieldKit()

virtual HPS::Publish::TextFieldKit::~TextFieldKit ( )

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

virtual

Indicates whether this TextFieldKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source TextFieldKit is equivalent to this TextFieldKit.

Parameters

in_kit The source TextFieldKit to compare to this TextFieldKit.

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

static

Creates a TextFieldKit 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 text field unless a setting is overridden by the TextFieldKit passed to a function.

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source TextFieldKit to compare to this TextFieldKit.

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

◆ operator=() [1/2]

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

Copies the source TextFieldKit into this TextFieldKit.

Parameters

in_kit The source TextFieldKit to copy.

Returns: A reference to this TextFieldKit.

◆ operator=() [2/2]

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

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

Parameters

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

Returns: A reference to this TextFieldKit.

◆ operator==()

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

Check if the source TextFieldKit is equivalent to this TextFieldKit.

Parameters

in_kit The source TextFieldKit to compare to this TextFieldKit.

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

Copies the source TextFieldKit into this TextFieldKit.

Parameters

in_kit The source TextFieldKit to copy.

◆ SetBorder()

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

Sets whether the text field has a border.

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

Parameters

in_state Whether the text field has a border.

Returns: A reference to this TextFieldKit.

◆ SetBorderColor()

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

Sets the border color for the text field.

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

Parameters

in_color The border color of the text field.

Returns: A reference to this TextFieldKit.

◆ SetBorderStyle()

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

Sets the border style for the text field.

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

Parameters

in_style The border style for the text field.

Returns: A reference to this TextFieldKit.

◆ SetBorderThickness()

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

Sets the border thickness for the text field.

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

Parameters

in_thickness The border thickness for the text field.

Returns: A reference to this TextFieldKit.

◆ SetDefaultValue()

TextFieldKit& HPS::Publish::TextFieldKit::SetDefaultValue ( char const * in_value )

Sets the default value for the text field.

This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcDefaultValue.

Parameters

in_value UT8-encoded default value for the text field.

Returns: A reference to this TextFieldKit.

◆ SetFillColor()

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

Sets the fill color for the text field.

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

Parameters

in_color The fill color for the text field.

Returns: A reference to this TextFieldKit.

◆ SetFont() [1/2]

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

Sets a builtin font for the text field.

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

Parameters

in_name The builtin font for the text field.

Returns: A reference to this TextFieldKit.

◆ SetFont() [2/2]

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

Sets a specific font for the text field.

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

Parameters

in_name	UTF8-encoded font name for the text field.
in_style	The style of font to use for the text field.

Returns: A reference to this TextFieldKit.

◆ SetFontSize()

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

Sets the font size for the text field.

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

Parameters

in_size The font size for the text field.

Returns: A reference to this TextFieldKit.

◆ SetLock()

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

Sets whether the text field is locked.

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

Parameters

in_state Whether the text field is locked.

Returns: A reference to this TextFieldKit.

◆ SetMultiline()

TextFieldKit& HPS::Publish::TextFieldKit::SetMultiline ( bool in_state )

Sets whether the text field is multiline.

This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bMultiline.

Parameters

in_state Whether the text field is multiline.

Returns: A reference to this TextFieldKit.

◆ SetName()

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

Sets the name of the text field.

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

Parameters

in_name UTF8-encoded name of the text field.

Returns: A reference to this TextFieldKit.

◆ SetPrintability()

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

Sets the printability for the text field.

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

Parameters

in_state The printability for the text field.

Returns: A reference to this TextFieldKit.

◆ SetReadOnly()

TextFieldKit& HPS::Publish::TextFieldKit::SetReadOnly ( bool in_state )

Sets whether the text field is read only.

This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bReadOnly.

Parameters

in_state Whether the text field can scroll.

Returns: A reference to this TextFieldKit.

◆ SetScrolling()

TextFieldKit& HPS::Publish::TextFieldKit::SetScrolling ( bool in_state )

Sets whether the text field can scroll.

This corresponds to the (inverted) value that will be passed to A3DPDFTextFieldData::m_bDoNotScroll.

Parameters

in_state Whether the text field can scroll.

Returns: A reference to this TextFieldKit.

◆ SetTextColor()

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

Sets the text color for the text field.

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

Parameters

in_color The text color for the text field.

Returns: A reference to this TextFieldKit.

◆ SetTextJustification()

TextFieldKit& HPS::Publish::TextFieldKit::SetTextJustification ( HPS::Text::Justification in_justification )

Sets the text justification for the text field.

This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextAlignment.

Parameters

in_justification The text justification for the text field.

Returns: A reference to this TextFieldKit.

◆ SetTextRotation()

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

Sets the text rotation for the text field.

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

Parameters

in_rotation The text rotation for the text field.

Returns: A reference to this TextFieldKit.

◆ SetTooltip()

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

Sets the tooltip for the text field.

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

Parameters

in_tooltip UTF8-encoded tooltip text for the text field.

Returns: A reference to this TextFieldKit.

◆ SetVisibility()

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

Sets the visibility for the text field.

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

Parameters

in_state The visibility for the text field.

Returns: A reference to this TextFieldKit.

◆ Show()

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

Copies this TextFieldKit into the given TextFieldKit.

Parameters

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

◆ ShowBorder()

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

Shows the border setting for the text field.

Parameters

out_state Whether the text field has a border.

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

◆ ShowBorderColor()

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

Shows the border color for the text field.

Parameters

out_color The border color of the text field.

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

◆ ShowBorderStyle()

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

Shows the border style for the text field.

Parameters

out_style The border style for the text field.

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

◆ ShowBorderThickness()

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

Shows the border thickness for the text field.

Parameters

out_thickness The border thickness for the text field.

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

◆ ShowDefaultValue()

bool HPS::Publish::TextFieldKit::ShowDefaultValue ( UTF8 & out_value ) const

Shows the default value for the text field.

Parameters

out_value The default value for the text field.

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

◆ ShowFillColor()

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

Shows the fill color for the text field.

Parameters

out_color The fill color for the text field.

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

◆ ShowFont()

bool HPS::Publish::TextFieldKit::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 text field.

Parameters

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

Shows the font size for the text field.

Parameters

out_size The font size for the text field.

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

◆ ShowLock()

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

Shows the lock setting for the text field.

Parameters

in_state Whether the text field is locked.

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

◆ ShowMultiline()

bool HPS::Publish::TextFieldKit::ShowMultiline ( bool & out_state ) const

Shows the multiline setting for the text field.

Parameters

out_state Whether the text field is multiline.

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

◆ ShowName()

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

Shows the name for the text field.

Parameters

out_name The name of the text field.

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

◆ ShowPrintability()

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

Shows the printability for the text field.

Parameters

out_state The printability for the text field.

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

◆ ShowReadOnly()

bool HPS::Publish::TextFieldKit::ShowReadOnly ( bool & out_state ) const

Shows the read-only setting for the text field.

Parameters

out_state Whether the text field is read only.

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

◆ ShowScrolling()

bool HPS::Publish::TextFieldKit::ShowScrolling ( bool & out_state ) const

Shows the scrolling setting for the text field.

Parameters

out_state Whether the text field can scroll.

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

◆ ShowTextColor()

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

Shows the text color for the text field.

Parameters

out_color The text color for the text field.

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

◆ ShowTextJustification()

bool HPS::Publish::TextFieldKit::ShowTextJustification ( HPS::Text::Justification & out_justification ) const

Shows the text justification for the text field.

Parameters

out_justification The text justification for the text field.

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

◆ ShowTextRotation()

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

Shows the text rotation for the text field.

Parameters

out_rotation The text rotation for the text field.

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

◆ ShowTooltip()

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

Shows the tooltip for the text field.

Parameters

out_tooltip The tooltip text for the text field.

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

◆ ShowVisibility()

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

Shows the visibility for the text field.

Parameters

out_state The visibility for the text field.

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

TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorder ( )

Removes the border setting.

Returns: A reference to this TextFieldKit.

◆ UnsetBorderColor()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderColor ( )

Removes the border color setting.

Returns: A reference to this TextFieldKit.

◆ UnsetBorderStyle()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderStyle ( )

Removes the border style setting.

Returns: A reference to this TextFieldKit.

◆ UnsetBorderThickness()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderThickness ( )

Removes the border thickness setting.

Returns: A reference to this TextFieldKit.

◆ UnsetDefaultValue()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetDefaultValue ( )

Removes the default value setting.

Returns: A reference to this TextFieldKit.

◆ UnsetEverything()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetEverything ( )

Removes all data from the text field.

Returns: A reference to this TextFieldKit.

◆ UnsetFillColor()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetFillColor ( )

Removes the fill color setting.

Returns: A reference to this TextFieldKit.

◆ UnsetFont()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetFont ( )

Removes the font setting.

Returns: A reference to this TextFieldKit.

◆ UnsetFontSize()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetFontSize ( )

Removes the font size setting.

Returns: A reference to this TextFieldKit.

◆ UnsetLock()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetLock ( )

Removes the lock setting.

Returns: A reference to this TextFieldKit.

◆ UnsetMultiline()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetMultiline ( )

Removes the multiline setting.

Returns: A reference to this TextFieldKit.

◆ UnsetName()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetName ( )

Removes the name setting.

Returns: A reference to this TextFieldKit.

◆ UnsetPrintability()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetPrintability ( )

Removes the printability setting.

Returns: A reference to this TextFieldKit.

◆ UnsetReadOnly()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetReadOnly ( )

Removes the read-only setting.

Returns: A reference to this TextFieldKit.

◆ UnsetScrolling()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetScrolling ( )

Removes the scrolling setting.

Returns: A reference to this TextFieldKit.

◆ UnsetTextColor()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextColor ( )

Removes the text color setting.

Returns: A reference to this TextFieldKit.

◆ UnsetTextJustification()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextJustification ( )

Removes the text justification setting.

Returns: A reference to this TextFieldKit.

◆ UnsetTextRotation()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextRotation ( )

Removes the text rotation setting.

Returns: A reference to this TextFieldKit.

◆ UnsetTooltip()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetTooltip ( )

Removes the tooltip setting.

Returns: A reference to this TextFieldKit.

◆ UnsetVisibility()

TextFieldKit& HPS::Publish::TextFieldKit::UnsetVisibility ( )

Removes the visibility setting.

Returns: A reference to this TextFieldKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Publish::TextFieldKit::staticType = HPS::Type::PublishTextFieldKit

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

◆ TextFieldKit() [1/3]

◆ TextFieldKit() [2/3]

◆ TextFieldKit() [3/3]

◆ ~TextFieldKit()

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

◆ SetDefaultValue()

◆ SetFillColor()

◆ SetFont() [1/2]

◆ SetFont() [2/2]

◆ SetFontSize()

◆ SetLock()

◆ SetMultiline()

◆ SetName()

◆ SetPrintability()

◆ SetReadOnly()

◆ SetScrolling()

◆ SetTextColor()

◆ SetTextJustification()

◆ SetTextRotation()

◆ SetTooltip()

◆ SetVisibility()

◆ Show()

◆ ShowBorder()

◆ ShowBorderColor()

◆ ShowBorderStyle()

◆ ShowBorderThickness()

◆ ShowDefaultValue()

◆ ShowFillColor()

◆ ShowFont()

◆ ShowFontSize()

◆ ShowLock()

◆ ShowMultiline()

◆ ShowName()

◆ ShowPrintability()

◆ ShowReadOnly()

◆ ShowScrolling()

◆ ShowTextColor()

◆ ShowTextJustification()

◆ ShowTextRotation()

◆ ShowTooltip()

◆ ShowVisibility()

◆ Type()

◆ UnsetBorder()

◆ UnsetBorderColor()

◆ UnsetBorderStyle()

◆ UnsetBorderThickness()

◆ UnsetDefaultValue()

◆ UnsetEverything()

◆ UnsetFillColor()

◆ UnsetFont()

◆ UnsetFontSize()

◆ UnsetLock()

◆ UnsetMultiline()

◆ UnsetName()

◆ UnsetPrintability()

◆ UnsetReadOnly()

◆ UnsetScrolling()