#include <sprk_publish.h>
|
static const HPS::Type | staticType = HPS::Type::PublishDropDownListKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ DropDownListKit() [1/3]
HPS::Publish::DropDownListKit::DropDownListKit |
( |
| ) |
|
◆ DropDownListKit() [2/3]
HPS::Publish::DropDownListKit::DropDownListKit |
( |
DropDownListKit const & |
in_kit | ) |
|
◆ DropDownListKit() [3/3]
HPS::Publish::DropDownListKit::DropDownListKit |
( |
DropDownListKit && |
in_kit | ) |
|
The move constructor creates a DropDownListKit by transferring the underlying object of the rvalue reference to this DropDownListKit.
- Parameters
-
in_kit | An rvalue reference to a DropDownListKit to take the underlying object from. |
◆ Empty()
bool HPS::Publish::DropDownListKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Publish::DropDownListKit::Equals |
( |
DropDownListKit const & |
in_kit | ) |
const |
◆ GetDefault()
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.
- Returns
- A DropDownListKit with the default settings.
◆ ObjectType()
HPS::Type HPS::Publish::DropDownListKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
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.
Reimplemented from HPS::SprocketKit.
◆ operator!=()
bool HPS::Publish::DropDownListKit::operator!= |
( |
DropDownListKit const & |
in_kit | ) |
const |
Check if the source DropDownListKit is not equivalent to this DropDownListKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying object of the rvalue reference to this DropDownListKit.
- Parameters
-
in_kit | An rvalue reference to a DropDownListKit to take the underlying object from. |
- Returns
- A reference to this DropDownListKit.
◆ operator==()
bool HPS::Publish::DropDownListKit::operator== |
( |
DropDownListKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetBorder()
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetContents() [1/2]
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.
- Parameters
-
in_displayed_values | The values displayed in the drop down list |
in_export_values | The export values associated with the values displayed |
- Returns
- A reference to this DropDownListKit.
◆ SetContents() [2/2]
DropDownListKit& HPS::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.
- Parameters
-
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 |
- Returns
- A reference to this DropDownListKit.
◆ SetCustomText()
DropDownListKit& HPS::Publish::DropDownListKit::SetCustomText |
( |
bool |
in_state | ) |
|
◆ SetFillColor()
◆ SetFont() [1/2]
◆ SetFont() [2/2]
Sets a specific font for the drop down list. This corresponds to the value that will be passed to A3DPDFDropDownListData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the drop down list. |
in_style | The style of font to use for the drop down list. |
- Returns
- A reference to this DropDownListKit.
◆ SetFontSize()
◆ SetImmediateCommit()
DropDownListKit& HPS::Publish::DropDownListKit::SetImmediateCommit |
( |
bool |
in_state | ) |
|
◆ SetLock()
◆ SetName()
DropDownListKit& HPS::Publish::DropDownListKit::SetName |
( |
char const * |
in_name | ) |
|
◆ SetPrintability()
DropDownListKit& HPS::Publish::DropDownListKit::SetPrintability |
( |
bool |
in_state | ) |
|
◆ SetSpellChecking()
DropDownListKit& HPS::Publish::DropDownListKit::SetSpellChecking |
( |
bool |
in_state | ) |
|
◆ SetTextColor()
◆ SetTextRotation()
◆ SetTooltip()
DropDownListKit& HPS::Publish::DropDownListKit::SetTooltip |
( |
char const * |
in_tooltip | ) |
|
◆ SetVisibility()
DropDownListKit& HPS::Publish::DropDownListKit::SetVisibility |
( |
bool |
in_state | ) |
|
◆ Show()
void HPS::Publish::DropDownListKit::Show |
( |
DropDownListKit & |
out_kit | ) |
const |
◆ ShowBorder()
bool HPS::Publish::DropDownListKit::ShowBorder |
( |
bool & |
out_state | ) |
const |
Shows the border setting for the drop down list.
- Parameters
-
out_state | Whether the drop down list has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS::Publish::DropDownListKit::ShowBorderColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the border color for the drop down list.
- Parameters
-
out_color | The border color of the drop down list. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
bool HPS::Publish::DropDownListKit::ShowBorderStyle |
( |
Border::Style & |
out_style | ) |
const |
Shows the border style for the drop down list.
- Parameters
-
out_style | The border style for the drop down list. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
bool HPS::Publish::DropDownListKit::ShowBorderThickness |
( |
Border::Thickness & |
out_thickness | ) |
const |
Shows the border thickness for the drop down list.
- Parameters
-
out_thickness | The border thickness for the drop down list. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowContents()
bool HPS::Publish::DropDownListKit::ShowContents |
( |
UTF8Array & |
out_displayed_values, |
|
|
UTF8Array & |
out_export_values |
|
) |
| const |
Shows the content setting for the drop down list
- Parameters
-
out_displayed_values | The values displayed by the drop down list |
out_export_values | The export values associated with the displayed values. |
- Returns
- true if a content setting was specified, false otherwise.
◆ ShowCustomText()
bool HPS::Publish::DropDownListKit::ShowCustomText |
( |
bool & |
out_state | ) |
const |
Shows the custom text setting for the drop down list.
- Parameters
-
out_state | Whether the user can enter custom text. |
- Returns
- true if a custom text setting was specified, false otherwise.
◆ ShowFillColor()
bool HPS::Publish::DropDownListKit::ShowFillColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the fill color for the drop down list.
- Parameters
-
out_color | The fill color for the drop down list. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the drop down list.
- Parameters
-
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. |
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
bool HPS::Publish::DropDownListKit::ShowFontSize |
( |
int & |
out_size | ) |
const |
Shows the font size for the drop down list.
- Parameters
-
out_size | The font size for the drop down list. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowImmediateCommit()
bool HPS::Publish::DropDownListKit::ShowImmediateCommit |
( |
bool & |
out_state | ) |
const |
Shows the immediate commit setting for the drop down list.
- Parameters
-
out_state | Whether selected values are committed immediately. |
- Returns
- true if an immediate commit setting was specified, false otherwise.
◆ ShowLock()
bool HPS::Publish::DropDownListKit::ShowLock |
( |
bool & |
out_state | ) |
const |
Shows the lock setting for the drop down list.
- Parameters
-
in_state | Whether the drop down list is locked. |
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowName()
bool HPS::Publish::DropDownListKit::ShowName |
( |
UTF8 & |
out_name | ) |
const |
Shows the name for the drop down list.
- Parameters
-
out_name | The name of the drop down list. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS::Publish::DropDownListKit::ShowPrintability |
( |
bool & |
out_state | ) |
const |
Shows the printability for the drop down list.
- Parameters
-
out_state | The printability for the drop down list. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowSpellChecking()
bool HPS::Publish::DropDownListKit::ShowSpellChecking |
( |
bool & |
out_state | ) |
const |
Shows the spell checking setting for the drop down list.
- Parameters
-
out_state | Whether spell checking is enabled. |
- Returns
- true if a spell checking setting was specified, false otherwise.
◆ ShowTextColor()
bool HPS::Publish::DropDownListKit::ShowTextColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the text color for the drop down list.
- Parameters
-
out_color | The text color for the drop down list. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextRotation()
bool HPS::Publish::DropDownListKit::ShowTextRotation |
( |
Text::Rotation & |
out_rotation | ) |
const |
Shows the text rotation for the drop down list.
- Parameters
-
out_rotation | The text rotation for the drop down list. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS::Publish::DropDownListKit::ShowTooltip |
( |
UTF8 & |
out_tooltip | ) |
const |
Shows the tooltip for the drop down list.
- Parameters
-
out_tooltip | The tooltip text for the drop down list. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS::Publish::DropDownListKit::ShowVisibility |
( |
bool & |
out_state | ) |
const |
Shows the visibility for the drop down list.
- Parameters
-
out_state | The visibility for the drop down list. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
◆ UnsetBorderColor()
Removes the border color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetBorderStyle()
Removes the border style setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetBorderThickness()
Removes the border thickness setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetContents()
◆ UnsetCustomText()
Removes the custom text setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetEverything()
Removes all data from the drop down list.
- Returns
- A reference to this DropDownListKit.
◆ UnsetFillColor()
Removes the fill color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetFont()
◆ UnsetFontSize()
◆ UnsetImmediateCommit()
Removes the immediate commit setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetLock()
◆ UnsetName()
◆ UnsetPrintability()
Removes the printability setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetSpellChecking()
Removes the spell checking setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTextColor()
Removes the text color setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTextRotation()
Removes the text rotation setting.
- Returns
- A reference to this DropDownListKit.
◆ UnsetTooltip()
◆ UnsetVisibility()
Removes the visibility setting.
- Returns
- A reference to this DropDownListKit.
The documentation for this class was generated from the following file: