REFERENCE MANUAL
#include <sprk_publish.h>
Static Public Member Functions | |
static DropDownListKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The DropDownListKit class is a user space object. It acts as the container for all data that can be used to specify a drop down list for a Publish PDF.
Publish::DropDownListKit::DropDownListKit | ( | ) |
The default constructor creates an empty DropDownListKit object.
Publish::DropDownListKit::DropDownListKit | ( | DropDownListKit const & | in_kit | ) |
The copy constructor creates a new DropDownListKit object that contains the same settings as the source DropDownListKit.
in_kit | The source DropDownListKit to copy. |
Publish::DropDownListKit::DropDownListKit | ( | DropDownListKit && | in_kit | ) |
The move constructor creates a DropDownListKit by transferring the underlying object of the rvalue reference to this DropDownListKit.
in_kit | An rvalue reference to a DropDownListKit to take the underlying object from. |
|
virtual |
Indicates whether this DropDownListKit has any values set on it.
Reimplemented from Object.
bool Publish::DropDownListKit::Equals | ( | DropDownListKit const & | in_kit | ) | const |
Check if the source DropDownListKit is equivalent to this DropDownListKit.
in_kit | The source DropDownListKit to compare to this DropDownListKit. |
|
static |
Creates a DropDownListKit 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 DropDownListKit 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::DropDownListKit::operator!= | ( | DropDownListKit const & | in_kit | ) | const |
Check if the source DropDownListKit is not equivalent to this DropDownListKit.
in_kit | The source DropDownListKit to compare to this DropDownListKit. |
DropDownListKit& Publish::DropDownListKit::operator= | ( | DropDownListKit const & | in_kit | ) |
Copies the source DropDownListKit into this DropDownListKit.
in_kit | The source DropDownListKit to copy. |
DropDownListKit& Publish::DropDownListKit::operator= | ( | DropDownListKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this DropDownListKit.
in_kit | An rvalue reference to a DropDownListKit to take the underlying object from. |
bool Publish::DropDownListKit::operator== | ( | DropDownListKit const & | in_kit | ) | const |
Check if the source DropDownListKit is equivalent to this DropDownListKit.
in_kit | The source DropDownListKit to compare to this DropDownListKit. |
void Publish::DropDownListKit::Set | ( | DropDownListKit const & | in_kit | ) |
Copies the source DropDownListKit into this DropDownListKit.
in_kit | The source DropDownListKit to copy. |
DropDownListKit& Publish::DropDownListKit::SetBorder | ( | bool | in_state | ) |
Sets whether the drop down list has a border. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bHasBorder.
in_state | Whether the drop down list has a border. |
DropDownListKit& Publish::DropDownListKit::SetBorderColor | ( | RGBColor const & | in_color | ) |
Sets the border color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sBorderColor.
in_color | The border color of the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetBorderStyle | ( | Border::Style | in_style | ) |
Sets the border style for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eLineStyleBorder.
in_style | The border style for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetBorderThickness | ( | Border::Thickness | in_thickness | ) |
Sets the border thickness for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eThicknessBorder.
in_thickness | The border thickness for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetContents | ( | UTF8Array const & | in_displayed_values, |
UTF8Array const & | in_export_values | ||
) |
Sets the contents of the drop down list. 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 drop down list |
in_export_values | The export values associated with the values displayed |
DropDownListKit& Publish::DropDownListKit::SetContents | ( | size_t | in_count, |
UTF8 const | in_displayed_values[], | ||
UTF8 const | in_export_values[] | ||
) |
Sets the contents of the drop down list. 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 drop down list |
in_export_values | The export values associated with the values displayed |
DropDownListKit& Publish::DropDownListKit::SetCustomText | ( | bool | in_state | ) |
Sets whether the user can enter custom text. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bAllowUserToEnterCustomText.
in_state | Whether the user can enter custom text. |
DropDownListKit& Publish::DropDownListKit::SetFillColor | ( | RGBColor const & | in_color | ) |
Sets the fill color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sFillColor and implicitly sets A3DPDFDropDownListData::m_bHasFillColor to true.
in_color | The fill color for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetFont | ( | Text::Font::Name | in_name | ) |
Sets a builtin font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.
in_name | The builtin font for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetFont | ( | char const * | in_name, |
Text::Font::Style | in_style = Text::Font::Style::Regular |
||
) |
Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.
in_name | UTF8-encoded font name for the drop down list. |
in_style | The style of font to use for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetFontSize | ( | int | in_size | ) |
Sets the font size for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_iFontSize.
in_size | The font size for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetImmediateCommit | ( | bool | in_state | ) |
Sets whether selected values are committed immediately. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCommitImmediate.
in_state | Whether selected values are committed immediately. |
DropDownListKit& Publish::DropDownListKit::SetLock | ( | bool | in_state | ) |
Sets whether the drop down list is locked. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bIsLocked.
in_state | Whether the drop down list is locked. |
DropDownListKit& Publish::DropDownListKit::SetName | ( | char const * | in_name | ) |
Sets the name of the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcName.
in_name | UTF8-encoded name of the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetPrintability | ( | bool | in_state | ) |
Sets the printability for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.
in_state | The printability for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetSpellChecking | ( | bool | in_state | ) |
Sets whether spell checking is enabled. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_bCheckSpelling.
in_state | Whether spell checking is enabled. |
DropDownListKit& Publish::DropDownListKit::SetTextColor | ( | RGBColor const & | in_color | ) |
Sets the text color for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_sTextColor.
in_color | The text color for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetTextRotation | ( | Text::Rotation | in_rotation | ) |
Sets the text rotation for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eTextOrientation.
in_rotation | The text rotation for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetTooltip | ( | char const * | in_tooltip | ) |
Sets the tooltip for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcTooltip.
in_tooltip | UTF8-encoded tooltip text for the drop down list. |
DropDownListKit& Publish::DropDownListKit::SetVisibility | ( | bool | in_state | ) |
Sets the visibility for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_eFormField.
in_state | The visibility for the drop down list. |
void Publish::DropDownListKit::Show | ( | DropDownListKit & | out_kit | ) | const |
Copies this DropDownListKit into the given DropDownListKit.
out_kit | The DropDownListKit to populate with the contents of this DropDownListKit. |
bool Publish::DropDownListKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the drop down list.
out_state | Whether the drop down list has a border. |
bool Publish::DropDownListKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the drop down list.
out_color | The border color of the drop down list. |
bool Publish::DropDownListKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the drop down list.
out_style | The border style for the drop down list. |
bool Publish::DropDownListKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the drop down list.
out_thickness | The border thickness for the drop down list. |
bool Publish::DropDownListKit::ShowContents | ( | UTF8Array & | out_displayed_values, |
UTF8Array & | out_export_values | ||
) | const |
Shows the content setting for the drop down list
out_displayed_values | The values displayed by the drop down list |
out_export_values | The export values associated with the displayed values. |
bool Publish::DropDownListKit::ShowCustomText | ( | bool & | out_state | ) | const |
Shows the custom text setting for the drop down list.
out_state | Whether the user can enter custom text. |
bool Publish::DropDownListKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the drop down list.
out_color | The fill color for the drop down list. |
bool Publish::DropDownListKit::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 drop down list.
out_type | The type of font for the drop down list. |
out_font | The built-in font for the drop down list. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the drop down list. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the drop down list. This is only valid if out_type is Text::Font::Type::Explicit. |
bool Publish::DropDownListKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the drop down list.
out_size | The font size for the drop down list. |
bool Publish::DropDownListKit::ShowImmediateCommit | ( | bool & | out_state | ) | const |
Shows the immediate commit setting for the drop down list.
out_state | Whether selected values are committed immediately. |
bool Publish::DropDownListKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the drop down list.
in_state | Whether the drop down list is locked. |
bool Publish::DropDownListKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the drop down list.
out_name | The name of the drop down list. |
bool Publish::DropDownListKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the drop down list.
out_state | The printability for the drop down list. |
bool Publish::DropDownListKit::ShowSpellChecking | ( | bool & | out_state | ) | const |
Shows the spell checking setting for the drop down list.
out_state | Whether spell checking is enabled. |
bool Publish::DropDownListKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the drop down list.
out_color | The text color for the drop down list. |
bool Publish::DropDownListKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the drop down list.
out_rotation | The text rotation for the drop down list. |
bool Publish::DropDownListKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the drop down list.
out_tooltip | The tooltip text for the drop down list. |
bool Publish::DropDownListKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the drop down list.
out_state | The visibility for the drop down list. |
DropDownListKit& Publish::DropDownListKit::UnsetBorder | ( | ) |
Removes the border setting.
DropDownListKit& Publish::DropDownListKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
DropDownListKit& Publish::DropDownListKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
DropDownListKit& Publish::DropDownListKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
DropDownListKit& Publish::DropDownListKit::UnsetContents | ( | ) |
Removes the content setting.
DropDownListKit& Publish::DropDownListKit::UnsetCustomText | ( | ) |
Removes the custom text setting.
DropDownListKit& Publish::DropDownListKit::UnsetEverything | ( | ) |
Removes all data from the drop down list.
DropDownListKit& Publish::DropDownListKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
DropDownListKit& Publish::DropDownListKit::UnsetFont | ( | ) |
Removes the font setting.
DropDownListKit& Publish::DropDownListKit::UnsetFontSize | ( | ) |
Removes the font size setting.
DropDownListKit& Publish::DropDownListKit::UnsetImmediateCommit | ( | ) |
Removes the immediate commit setting.
DropDownListKit& Publish::DropDownListKit::UnsetLock | ( | ) |
Removes the lock setting.
DropDownListKit& Publish::DropDownListKit::UnsetName | ( | ) |
Removes the name setting.
DropDownListKit& Publish::DropDownListKit::UnsetPrintability | ( | ) |
Removes the printability setting.
DropDownListKit& Publish::DropDownListKit::UnsetSpellChecking | ( | ) |
Removes the spell checking setting.
DropDownListKit& Publish::DropDownListKit::UnsetTextColor | ( | ) |
Removes the text color setting.
DropDownListKit& Publish::DropDownListKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
DropDownListKit& Publish::DropDownListKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
DropDownListKit& Publish::DropDownListKit::UnsetVisibility | ( | ) |
Removes the visibility setting.