#include <sprk_publish.h>
|
static const HPS::Type | staticType = HPS::Type::PublishTextFieldKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The TextFieldKit class is a user space object. It acts as the container for all data that can be used to specify a text field for a Publish PDF.
◆ TextFieldKit() [1/3]
HPS::Publish::TextFieldKit::TextFieldKit |
( |
| ) |
|
The default constructor creates an empty TextFieldKit object.
◆ TextFieldKit() [2/3]
HPS::Publish::TextFieldKit::TextFieldKit |
( |
TextFieldKit const & |
in_kit | ) |
|
The copy constructor creates a new TextFieldKit object that contains the same settings as the source TextFieldKit.
- Parameters
-
◆ TextFieldKit() [3/3]
HPS::Publish::TextFieldKit::TextFieldKit |
( |
TextFieldKit && |
in_kit | ) |
|
The move constructor creates a TextFieldKit by transferring the underlying object of the rvalue reference to this TextFieldKit.
- Parameters
-
in_kit | An rvalue reference to a TextFieldKit to take the underlying object from. |
◆ Empty()
bool HPS::Publish::TextFieldKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Publish::TextFieldKit::Equals |
( |
TextFieldKit const & |
in_kit | ) |
const |
Check if the source TextFieldKit is equivalent to this TextFieldKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
static TextFieldKit HPS::Publish::TextFieldKit::GetDefault |
( |
| ) |
|
|
static |
Creates a TextFieldKit 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 text field unless a setting is overridden by the TextFieldKit passed to a function.
- Returns
- A TextFieldKit with the default settings.
◆ ObjectType()
HPS::Type HPS::Publish::TextFieldKit::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::TextFieldKit::operator!= |
( |
TextFieldKit const & |
in_kit | ) |
const |
Check if the source TextFieldKit is not equivalent to this TextFieldKit.
- 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 TextFieldKit.
- Parameters
-
in_kit | An rvalue reference to a TextFieldKit to take the underlying object from. |
- Returns
- A reference to this TextFieldKit.
◆ operator==()
bool HPS::Publish::TextFieldKit::operator== |
( |
TextFieldKit const & |
in_kit | ) |
const |
Check if the source TextFieldKit is equivalent to this TextFieldKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::TextFieldKit::Set |
( |
TextFieldKit const & |
in_kit | ) |
|
◆ SetBorder()
TextFieldKit& HPS::Publish::TextFieldKit::SetBorder |
( |
bool |
in_state | ) |
|
Sets whether the text field has a border. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bHasBorder.
- Parameters
-
in_state | Whether the text field has a border. |
- Returns
- A reference to this TextFieldKit.
◆ SetBorderColor()
◆ SetBorderStyle()
◆ SetBorderThickness()
◆ SetDefaultValue()
TextFieldKit& HPS::Publish::TextFieldKit::SetDefaultValue |
( |
char const * |
in_value | ) |
|
◆ SetFillColor()
◆ SetFont() [1/2]
◆ SetFont() [2/2]
Sets a specific font for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcFontName.
- Parameters
-
in_name | UTF8-encoded font name for the text field. |
in_style | The style of font to use for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetFontSize()
TextFieldKit& HPS::Publish::TextFieldKit::SetFontSize |
( |
int |
in_size | ) |
|
◆ SetLock()
TextFieldKit& HPS::Publish::TextFieldKit::SetLock |
( |
bool |
in_state | ) |
|
◆ SetMultiline()
TextFieldKit& HPS::Publish::TextFieldKit::SetMultiline |
( |
bool |
in_state | ) |
|
Sets whether the text field is multiline. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bMultiline.
- Parameters
-
in_state | Whether the text field is multiline. |
- Returns
- A reference to this TextFieldKit.
◆ SetName()
TextFieldKit& HPS::Publish::TextFieldKit::SetName |
( |
char const * |
in_name | ) |
|
Sets the name of the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcName.
- Parameters
-
in_name | UTF8-encoded name of the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetPrintability()
TextFieldKit& HPS::Publish::TextFieldKit::SetPrintability |
( |
bool |
in_state | ) |
|
Sets the printability for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eFormField.
- Parameters
-
in_state | The printability for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetReadOnly()
TextFieldKit& HPS::Publish::TextFieldKit::SetReadOnly |
( |
bool |
in_state | ) |
|
Sets whether the text field is read only. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_bReadOnly.
- Parameters
-
in_state | Whether the text field can scroll. |
- Returns
- A reference to this TextFieldKit.
◆ SetScrolling()
TextFieldKit& HPS::Publish::TextFieldKit::SetScrolling |
( |
bool |
in_state | ) |
|
Sets whether the text field can scroll. This corresponds to the (inverted) value that will be passed to A3DPDFTextFieldData::m_bDoNotScroll.
- Parameters
-
in_state | Whether the text field can scroll. |
- Returns
- A reference to this TextFieldKit.
◆ SetTextColor()
◆ SetTextJustification()
Sets the text justification for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_eTextAlignment.
- Parameters
-
in_justification | The text justification for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetTextRotation()
◆ SetTooltip()
TextFieldKit& HPS::Publish::TextFieldKit::SetTooltip |
( |
char const * |
in_tooltip | ) |
|
Sets the tooltip for the text field. This corresponds to the value that will be passed to A3DPDFTextFieldData::m_pcTooltip.
- Parameters
-
in_tooltip | UTF8-encoded tooltip text for the text field. |
- Returns
- A reference to this TextFieldKit.
◆ SetVisibility()
TextFieldKit& HPS::Publish::TextFieldKit::SetVisibility |
( |
bool |
in_state | ) |
|
◆ Show()
void HPS::Publish::TextFieldKit::Show |
( |
TextFieldKit & |
out_kit | ) |
const |
◆ ShowBorder()
bool HPS::Publish::TextFieldKit::ShowBorder |
( |
bool & |
out_state | ) |
const |
Shows the border setting for the text field.
- Parameters
-
out_state | Whether the text field has a border. |
- Returns
- true if a border setting was specified, false otherwise.
◆ ShowBorderColor()
bool HPS::Publish::TextFieldKit::ShowBorderColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the border color for the text field.
- Parameters
-
out_color | The border color of the text field. |
- Returns
- true if a border color was specified, false otherwise.
◆ ShowBorderStyle()
bool HPS::Publish::TextFieldKit::ShowBorderStyle |
( |
Border::Style & |
out_style | ) |
const |
Shows the border style for the text field.
- Parameters
-
out_style | The border style for the text field. |
- Returns
- true if a border style was specified, false otherwise.
◆ ShowBorderThickness()
bool HPS::Publish::TextFieldKit::ShowBorderThickness |
( |
Border::Thickness & |
out_thickness | ) |
const |
Shows the border thickness for the text field.
- Parameters
-
out_thickness | The border thickness for the text field. |
- Returns
- true if a border thickness was specified, false otherwise.
◆ ShowDefaultValue()
bool HPS::Publish::TextFieldKit::ShowDefaultValue |
( |
UTF8 & |
out_value | ) |
const |
Shows the default value for the text field.
- Parameters
-
out_value | The default value for the text field. |
- Returns
- true if a default value was specified, false otherwise.
◆ ShowFillColor()
bool HPS::Publish::TextFieldKit::ShowFillColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the fill color for the text field.
- Parameters
-
out_color | The fill color for the text field. |
- Returns
- true if a fill color was specified, false otherwise.
◆ ShowFont()
Shows the font for the text field.
- Parameters
-
- Returns
- true if a font was specified, false otherwise.
◆ ShowFontSize()
bool HPS::Publish::TextFieldKit::ShowFontSize |
( |
int & |
out_size | ) |
const |
Shows the font size for the text field.
- Parameters
-
out_size | The font size for the text field. |
- Returns
- true if a font size was specified, false otherwise.
◆ ShowLock()
bool HPS::Publish::TextFieldKit::ShowLock |
( |
bool & |
out_state | ) |
const |
Shows the lock setting for the text field.
- Parameters
-
in_state | Whether the text field is locked. |
- Returns
- true if a lock setting was specified, false otherwise.
◆ ShowMultiline()
bool HPS::Publish::TextFieldKit::ShowMultiline |
( |
bool & |
out_state | ) |
const |
Shows the multiline setting for the text field.
- Parameters
-
out_state | Whether the text field is multiline. |
- Returns
- true if a multiline setting was specified, false otherwise.
◆ ShowName()
bool HPS::Publish::TextFieldKit::ShowName |
( |
UTF8 & |
out_name | ) |
const |
Shows the name for the text field.
- Parameters
-
out_name | The name of the text field. |
- Returns
- true if a name was specified, false otherwise.
◆ ShowPrintability()
bool HPS::Publish::TextFieldKit::ShowPrintability |
( |
bool & |
out_state | ) |
const |
Shows the printability for the text field.
- Parameters
-
out_state | The printability for the text field. |
- Returns
- true if a printability was specified, false otherwise.
◆ ShowReadOnly()
bool HPS::Publish::TextFieldKit::ShowReadOnly |
( |
bool & |
out_state | ) |
const |
Shows the read-only setting for the text field.
- Parameters
-
out_state | Whether the text field is read only. |
- Returns
- true if a scrolling setting was specified, false otherwise.
◆ ShowScrolling()
bool HPS::Publish::TextFieldKit::ShowScrolling |
( |
bool & |
out_state | ) |
const |
Shows the scrolling setting for the text field.
- Parameters
-
out_state | Whether the text field can scroll. |
- Returns
- true if a scrolling setting was specified, false otherwise.
◆ ShowTextColor()
bool HPS::Publish::TextFieldKit::ShowTextColor |
( |
RGBColor & |
out_color | ) |
const |
Shows the text color for the text field.
- Parameters
-
out_color | The text color for the text field. |
- Returns
- true if a text color was specified, false otherwise.
◆ ShowTextJustification()
Shows the text justification for the text field.
- Parameters
-
out_justification | The text justification for the text field. |
- Returns
- true if a text justification was specified, false otherwise.
◆ ShowTextRotation()
bool HPS::Publish::TextFieldKit::ShowTextRotation |
( |
Text::Rotation & |
out_rotation | ) |
const |
Shows the text rotation for the text field.
- Parameters
-
out_rotation | The text rotation for the text field. |
- Returns
- true if a rotation was specified, false otherwise.
◆ ShowTooltip()
bool HPS::Publish::TextFieldKit::ShowTooltip |
( |
UTF8 & |
out_tooltip | ) |
const |
Shows the tooltip for the text field.
- Parameters
-
out_tooltip | The tooltip text for the text field. |
- Returns
- true if a tooltip was specified, false otherwise.
◆ ShowVisibility()
bool HPS::Publish::TextFieldKit::ShowVisibility |
( |
bool & |
out_state | ) |
const |
Shows the visibility for the text field.
- Parameters
-
out_state | The visibility for the text field. |
- Returns
- true if a visibility was specified, false otherwise.
◆ UnsetBorder()
Removes the border setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderColor()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderColor |
( |
| ) |
|
Removes the border color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderStyle()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderStyle |
( |
| ) |
|
Removes the border style setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetBorderThickness()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetBorderThickness |
( |
| ) |
|
Removes the border thickness setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetDefaultValue()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetDefaultValue |
( |
| ) |
|
Removes the default value setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetEverything()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetEverything |
( |
| ) |
|
Removes all data from the text field.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFillColor()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetFillColor |
( |
| ) |
|
Removes the fill color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFont()
Removes the font setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetFontSize()
Removes the font size setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetLock()
Removes the lock setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetMultiline()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetMultiline |
( |
| ) |
|
Removes the multiline setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetName()
Removes the name setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetPrintability()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetPrintability |
( |
| ) |
|
Removes the printability setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetReadOnly()
Removes the read-only setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetScrolling()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetScrolling |
( |
| ) |
|
Removes the scrolling setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextColor()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextColor |
( |
| ) |
|
Removes the text color setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextJustification()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextJustification |
( |
| ) |
|
Removes the text justification setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTextRotation()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetTextRotation |
( |
| ) |
|
Removes the text rotation setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetTooltip()
Removes the tooltip setting.
- Returns
- A reference to this TextFieldKit.
◆ UnsetVisibility()
TextFieldKit& HPS::Publish::TextFieldKit::UnsetVisibility |
( |
| ) |
|
Removes the visibility setting.
- Returns
- A reference to this TextFieldKit.
The documentation for this class was generated from the following file: