HPS::Publish::ListBoxKit

class HPS::Publish::ListBoxKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this ListBoxKit has any values set on it.

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

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

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

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

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!=(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.

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.

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.

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

void Set(ListBoxKit const &in_kit)

Copies the source ListBoxKit into this ListBoxKit.

Parameters: in_kit – The source ListBoxKit to copy.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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

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

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

ListBoxKit &UnsetBorder()

Removes the border setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetBorderColor()

Removes the border color setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetBorderStyle()

Removes the border style setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetBorderThickness()

Removes the border thickness setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetContents()

Removes the content setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetEverything()

Removes all data from the list box.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetFillColor()

Removes the fill color setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetFont()

Removes the font setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetFontSize()

Removes the font size setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetLock()

Removes the lock setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetMultipleSelection()

Removes the multiple selection setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetName()

Removes the name setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetPrintability()

Removes the printability setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetTextColor()

Removes the text color setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetTextRotation()

Removes the text rotation setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetTooltip()

Removes the tooltip setting.

Returns: A reference to this ListBoxKit.

ListBoxKit &UnsetVisibility()

Removes the visibility setting.

Returns: A reference to this ListBoxKit.

virtual ~ListBoxKit()

Public Static Functions

static ListBoxKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishListBoxKit