HPS::Publish::TextFieldKit

class HPS::Publish::TextFieldKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this TextFieldKit has any values set on it.

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

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

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns: The declared type of the object in question, which may differ from the true, underlying type.

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

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.

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.

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

void Set(TextFieldKit const &in_kit)

Copies the source TextFieldKit into this TextFieldKit.

Parameters: in_kit – The source TextFieldKit to copy.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

TextFieldKit(): The default constructor creates an empty TextFieldKit object.

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

Removes the border setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetBorderColor()

Removes the border color setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetBorderStyle()

Removes the border style setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetBorderThickness()

Removes the border thickness setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetDefaultValue()

Removes the default value setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetEverything()

Removes all data from the text field.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetFillColor()

Removes the fill color setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetFont()

Removes the font setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetFontSize()

Removes the font size setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetLock()

Removes the lock setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetMultiline()

Removes the multiline setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetName()

Removes the name setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetPrintability()

Removes the printability setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetReadOnly()

Removes the read-only setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetScrolling()

Removes the scrolling setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetTextColor()

Removes the text color setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetTextJustification()

Removes the text justification setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetTextRotation()

Removes the text rotation setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetTooltip()

Removes the tooltip setting.

Returns: A reference to this TextFieldKit.

TextFieldKit &UnsetVisibility()

Removes the visibility setting.

Returns: A reference to this TextFieldKit.

virtual ~TextFieldKit()

Public Static Functions

static TextFieldKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishTextFieldKit