#include <sprk_publish.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ListBoxKit const &in_kit) const |
ListBoxKit () | |
ListBoxKit (ListBoxKit const &in_kit) | |
ListBoxKit (ListBoxKit &&in_kit) | |
HPS::Type | ObjectType () const |
bool | operator!= (ListBoxKit const &in_kit) const |
ListBoxKit & | operator= (ListBoxKit const &in_kit) |
ListBoxKit & | operator= (ListBoxKit &&in_kit) |
bool | operator== (ListBoxKit const &in_kit) const |
void | Set (ListBoxKit const &in_kit) |
ListBoxKit & | SetBorder (bool in_state) |
ListBoxKit & | SetBorderColor (RGBColor const &in_color) |
ListBoxKit & | SetBorderStyle (Border::Style in_style) |
ListBoxKit & | SetBorderThickness (Border::Thickness in_thickness) |
ListBoxKit & | SetContents (UTF8Array const &in_displayed_values, UTF8Array const &in_export_values) |
ListBoxKit & | SetContents (size_t in_count, UTF8 const in_displayed_values[], UTF8 const in_export_values[]) |
ListBoxKit & | SetFillColor (RGBColor const &in_color) |
ListBoxKit & | SetFont (Text::Font::Name in_name) |
ListBoxKit & | SetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular) |
ListBoxKit & | SetFontSize (int in_size) |
ListBoxKit & | SetLock (bool in_state) |
ListBoxKit & | SetMultipleSelection (bool in_state) |
ListBoxKit & | SetName (char const *in_name) |
ListBoxKit & | SetPrintability (bool in_state) |
ListBoxKit & | SetTextColor (RGBColor const &in_color) |
ListBoxKit & | SetTextRotation (Text::Rotation in_rotation) |
ListBoxKit & | SetTooltip (char const *in_tooltip) |
ListBoxKit & | SetVisibility (bool in_state) |
void | Show (ListBoxKit &out_kit) const |
bool | ShowBorder (bool &out_state) const |
bool | ShowBorderColor (RGBColor &out_color) const |
bool | ShowBorderStyle (Border::Style &out_style) const |
bool | ShowBorderThickness (Border::Thickness &out_thickness) const |
bool | ShowContents (UTF8Array &out_displayed_values, UTF8Array &out_export_values) const |
bool | ShowFillColor (RGBColor &out_color) const |
bool | ShowFont (Text::Font::Type &out_type, Text::Font::Name &out_font, UTF8 &out_font_name, Text::Font::Style &out_style) const |
bool | ShowFontSize (int &out_size) const |
bool | ShowLock (bool &out_state) const |
bool | ShowMultipleSelection (bool &out_state) const |
bool | ShowName (UTF8 &out_name) const |
bool | ShowPrintability (bool &out_state) const |
bool | ShowTextColor (RGBColor &out_color) const |
bool | ShowTextRotation (Text::Rotation &out_rotation) const |
bool | ShowTooltip (UTF8 &out_tooltip) const |
bool | ShowVisibility (bool &out_state) const |
ListBoxKit & | UnsetBorder () |
ListBoxKit & | UnsetBorderColor () |
ListBoxKit & | UnsetBorderStyle () |
ListBoxKit & | UnsetBorderThickness () |
ListBoxKit & | UnsetContents () |
ListBoxKit & | UnsetEverything () |
ListBoxKit & | UnsetFillColor () |
ListBoxKit & | UnsetFont () |
ListBoxKit & | UnsetFontSize () |
ListBoxKit & | UnsetLock () |
ListBoxKit & | UnsetMultipleSelection () |
ListBoxKit & | UnsetName () |
ListBoxKit & | UnsetPrintability () |
ListBoxKit & | UnsetTextColor () |
ListBoxKit & | UnsetTextRotation () |
ListBoxKit & | UnsetTooltip () |
ListBoxKit & | UnsetVisibility () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Member Functions | |
static ListBoxKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishListBoxKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
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
HPS::Publish::ListBoxKit::ListBoxKit | ( | ) |
The default constructor creates an empty ListBoxKit object.
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.
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.
Member Function Documentation
|
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.
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.
|
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.
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.
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.
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.
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.
void HPS::Publish::ListBoxKit::Set | ( | ListBoxKit const & | in_kit | ) |
Copies the source ListBoxKit into this ListBoxKit.
- Parameters
-
in_kit The source ListBoxKit to copy.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorder | ( | ) |
Removes the border setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetContents | ( | ) |
Removes the content setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetEverything | ( | ) |
Removes all data from the list box.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetFont | ( | ) |
Removes the font setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetFontSize | ( | ) |
Removes the font size setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetLock | ( | ) |
Removes the lock setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetMultipleSelection | ( | ) |
Removes the multiple selection setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetName | ( | ) |
Removes the name setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetPrintability | ( | ) |
Removes the printability setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetTextColor | ( | ) |
Removes the text color setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
- Returns
- A reference to this ListBoxKit.
ListBoxKit& HPS::Publish::ListBoxKit::UnsetVisibility | ( | ) |
Removes the visibility setting.
- Returns
- A reference to this ListBoxKit.
The documentation for this class was generated from the following file:
- include/sprk_publish.h