REFERENCE MANUAL
#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) | |
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_name, 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 (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static ListBoxKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
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.
Publish::ListBoxKit::ListBoxKit | ( | ) |
The default constructor creates an empty ListBoxKit object.
Publish::ListBoxKit::ListBoxKit | ( | ListBoxKit const & | in_kit | ) |
The copy constructor creates a new ListBoxKit object that contains the same settings as the source ListBoxKit.
in_kit | The source ListBoxKit to copy. |
Publish::ListBoxKit::ListBoxKit | ( | ListBoxKit && | in_kit | ) |
The move constructor creates a ListBoxKit by transferring the underlying object of the rvalue reference to this ListBoxKit.
in_kit | An rvalue reference to a ListBoxKit to take the underlying object from. |
|
virtual |
Indicates whether this ListBoxKit has any values set on it.
Reimplemented from Object.
bool Publish::ListBoxKit::Equals | ( | ListBoxKit const & | in_kit | ) | const |
Check if the source ListBoxKit is equivalent to this ListBoxKit.
in_kit | The source ListBoxKit to compare to this ListBoxKit. |
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Publish::ListBoxKit::operator!= | ( | ListBoxKit const & | in_kit | ) | const |
Check if the source ListBoxKit is not equivalent to this ListBoxKit.
in_kit | The source ListBoxKit to compare to this ListBoxKit. |
ListBoxKit& Publish::ListBoxKit::operator= | ( | ListBoxKit const & | in_kit | ) |
Copies the source ListBoxKit into this ListBoxKit.
in_kit | The source ListBoxKit to copy. |
ListBoxKit& Publish::ListBoxKit::operator= | ( | ListBoxKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ListBoxKit.
in_kit | An rvalue reference to a ListBoxKit to take the underlying object from. |
bool Publish::ListBoxKit::operator== | ( | ListBoxKit const & | in_kit | ) | const |
Check if the source ListBoxKit is equivalent to this ListBoxKit.
in_kit | The source ListBoxKit to compare to this ListBoxKit. |
void Publish::ListBoxKit::Set | ( | ListBoxKit const & | in_kit | ) |
Copies the source ListBoxKit into this ListBoxKit.
in_kit | The source ListBoxKit to copy. |
ListBoxKit& 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.
in_state | Whether the list box has a border. |
ListBoxKit& 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.
in_color | The border color of the list box. |
ListBoxKit& 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.
in_style | The border style for the list box. |
ListBoxKit& 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.
in_thickness | The border thickness for the list box. |
ListBoxKit& 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.
in_displayed_values | The values displayed in the list box |
in_export_values | The export values associated with the values displayed |
ListBoxKit& 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.
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 |
ListBoxKit& 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.
in_color | The fill color for the list box. |
ListBoxKit& 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.
in_name | The builtin font for the list box. |
ListBoxKit& 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.
in_name | UTF8-encoded font name for the list box. |
in_style | The style of font to use for the list box. |
ListBoxKit& 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.
in_size | The font size for the list box. |
ListBoxKit& 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.
in_state | Whether the list box is locked. |
ListBoxKit& 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.
in_state | Whether multiple selection is allowed |
ListBoxKit& 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.
in_name | UTF8-encoded name of the list box. |
ListBoxKit& 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.
in_state | The printability for the list box. |
ListBoxKit& 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.
in_color | The text color for the list box. |
ListBoxKit& 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.
in_rotation | The text rotation for the list box. |
ListBoxKit& 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.
in_tooltip | UTF8-encoded tooltip text for the list box. |
ListBoxKit& 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.
in_state | The visibility for the list box. |
void Publish::ListBoxKit::Show | ( | ListBoxKit & | out_kit | ) | const |
Copies this ListBoxKit into the given ListBoxKit.
out_kit | The ListBoxKit to populate with the contents of this ListBoxKit. |
bool Publish::ListBoxKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the list box.
out_state | Whether the list box has a border. |
bool Publish::ListBoxKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the list box.
out_color | The border color of the list box. |
bool Publish::ListBoxKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the list box.
out_style | The border style for the list box. |
bool Publish::ListBoxKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the list box.
out_thickness | The border thickness for the list box. |
bool Publish::ListBoxKit::ShowContents | ( | UTF8Array & | out_displayed_values, |
UTF8Array & | out_export_values | ||
) | const |
Shows the content setting for the list box.
out_displayed_values | The values displayed by the list box. |
out_export_values | The export values associated with the displayed values. |
bool Publish::ListBoxKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the list box.
out_color | The fill color for the list box. |
bool Publish::ListBoxKit::ShowFont | ( | Text::Font::Type & | out_type, |
Text::Font::Name & | out_name, | ||
UTF8 & | out_font_name, | ||
Text::Font::Style & | out_style | ||
) | const |
Shows the font for the list box.
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. |
bool Publish::ListBoxKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the list box.
out_size | The font size for the list box. |
bool Publish::ListBoxKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the list box.
in_state | Whether the list box is locked. |
bool Publish::ListBoxKit::ShowMultipleSelection | ( | bool & | out_state | ) | const |
Shows the multiple selection setting for the list box.
out_state | Whether multiple selection is enabled. |
bool Publish::ListBoxKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the list box.
out_name | The name of the list box. |
bool Publish::ListBoxKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the list box.
out_state | The printability for the list box. |
bool Publish::ListBoxKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the list box.
out_color | The text color for the list box. |
bool Publish::ListBoxKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the list box.
out_rotation | The text rotation for the list box. |
bool Publish::ListBoxKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the list box.
out_tooltip | The tooltip text for the list box. |
bool Publish::ListBoxKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the list box.
out_state | The visibility for the list box. |
ListBoxKit& Publish::ListBoxKit::UnsetBorder | ( | ) |
Removes the border setting.
ListBoxKit& Publish::ListBoxKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
ListBoxKit& Publish::ListBoxKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
ListBoxKit& Publish::ListBoxKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
ListBoxKit& Publish::ListBoxKit::UnsetContents | ( | ) |
Removes the content setting.
ListBoxKit& Publish::ListBoxKit::UnsetEverything | ( | ) |
Removes all data from the list box.
ListBoxKit& Publish::ListBoxKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
ListBoxKit& Publish::ListBoxKit::UnsetFont | ( | ) |
Removes the font setting.
ListBoxKit& Publish::ListBoxKit::UnsetFontSize | ( | ) |
Removes the font size setting.
ListBoxKit& Publish::ListBoxKit::UnsetLock | ( | ) |
Removes the lock setting.
ListBoxKit& Publish::ListBoxKit::UnsetMultipleSelection | ( | ) |
Removes the multiple selection setting.
ListBoxKit& Publish::ListBoxKit::UnsetName | ( | ) |
Removes the name setting.
ListBoxKit& Publish::ListBoxKit::UnsetPrintability | ( | ) |
Removes the printability setting.
ListBoxKit& Publish::ListBoxKit::UnsetTextColor | ( | ) |
Removes the text color setting.
ListBoxKit& Publish::ListBoxKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
ListBoxKit& Publish::ListBoxKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
ListBoxKit& Publish::ListBoxKit::UnsetVisibility | ( | ) |
Removes the visibility setting.