The SignatureFieldKit class is a user space object. More...
#include <sprk_publish.h>
Public Member Functions | |
SignatureFieldKit () | |
The default constructor creates an empty SignatureFieldKit object. More... | |
SignatureFieldKit (SignatureFieldKit const &in_kit) | |
The copy constructor creates a new SignatureFieldKit object that contains the same settings as the source SignatureFieldKit. More... | |
SignatureFieldKit (SignatureFieldKit &&in_kit) | |
The move constructor creates a SignatureFieldKit by transferring the underlying object of the rvalue reference to this SignatureFieldKit. More... | |
virtual | ~SignatureFieldKit () |
HPS::Type | ObjectType () const |
void | Set (SignatureFieldKit const &in_kit) |
Copies the source SignatureFieldKit into this SignatureFieldKit. More... | |
void | Show (SignatureFieldKit &out_kit) const |
Copies this SignatureFieldKit into the given SignatureFieldKit. More... | |
SignatureFieldKit & | operator= (SignatureFieldKit const &in_kit) |
Copies the source SignatureFieldKit into this SignatureFieldKit. More... | |
SignatureFieldKit & | operator= (SignatureFieldKit &&in_kit) |
The move assignment operator transfers the underlying object of the rvalue reference to this SignatureFieldKit. More... | |
bool | Empty () const |
Indicates whether this SignatureFieldKit has any values set on it. More... | |
bool | Equals (SignatureFieldKit const &in_kit) const |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit. More... | |
bool | operator== (SignatureFieldKit const &in_kit) const |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit. More... | |
bool | operator!= (SignatureFieldKit const &in_kit) const |
Check if the source SignatureFieldKit is not equivalent to this SignatureFieldKit. More... | |
SignatureFieldKit & | SetName (char const *in_name) |
Sets the name of the signature field. More... | |
SignatureFieldKit & | SetFont (Text::Font::Name in_name) |
Sets a builtin font for the signature field. More... | |
SignatureFieldKit & | SetFont (char const *in_name, Text::Font::Style in_style=Text::Font::Style::Regular) |
Sets a specific font for the signature field. More... | |
SignatureFieldKit & | SetFontSize (int in_size) |
Sets the font size for the signature field. More... | |
SignatureFieldKit & | SetTextColor (RGBColor const &in_color) |
Sets the text color for the signature field. More... | |
SignatureFieldKit & | SetTooltip (char const *in_tooltip) |
Sets the tooltip for the signature field. More... | |
SignatureFieldKit & | SetVisibility (bool in_state) |
Sets the visibility for the signature field. More... | |
SignatureFieldKit & | SetPrintability (bool in_state) |
Sets the printability for the signature field. More... | |
SignatureFieldKit & | SetTextRotation (Text::Rotation in_rotation) |
Sets the text rotation for the signature field. More... | |
SignatureFieldKit & | SetLock (bool in_state) |
Sets whether the signature field is locked. More... | |
SignatureFieldKit & | SetBorder (bool in_state) |
Sets whether the signature field has a border. More... | |
SignatureFieldKit & | SetBorderColor (RGBColor const &in_color) |
Sets the border color for the signature field. More... | |
SignatureFieldKit & | SetBorderThickness (Border::Thickness in_thickness) |
Sets the border thickness for the signature field. More... | |
SignatureFieldKit & | SetBorderStyle (Border::Style in_style) |
Sets the border style for the signature field. More... | |
SignatureFieldKit & | SetFillColor (RGBColor const &in_color) |
Sets the fill color for the signature field. More... | |
SignatureFieldKit & | UnsetName () |
Removes the name setting. More... | |
SignatureFieldKit & | UnsetFont () |
Removes the font setting. More... | |
SignatureFieldKit & | UnsetFontSize () |
Removes the font size setting. More... | |
SignatureFieldKit & | UnsetTextColor () |
Removes the text color setting. More... | |
SignatureFieldKit & | UnsetTooltip () |
Removes the tooltip setting. More... | |
SignatureFieldKit & | UnsetVisibility () |
Removes the visibility setting. More... | |
SignatureFieldKit & | UnsetPrintability () |
Removes the printability setting. More... | |
SignatureFieldKit & | UnsetTextRotation () |
Removes the text rotation setting. More... | |
SignatureFieldKit & | UnsetLock () |
Removes the lock setting. More... | |
SignatureFieldKit & | UnsetBorder () |
Removes the border setting. More... | |
SignatureFieldKit & | UnsetBorderColor () |
Removes the border color setting. More... | |
SignatureFieldKit & | UnsetBorderThickness () |
Removes the border thickness setting. More... | |
SignatureFieldKit & | UnsetBorderStyle () |
Removes the border style setting. More... | |
SignatureFieldKit & | UnsetFillColor () |
Removes the fill color setting. More... | |
SignatureFieldKit & | UnsetEverything () |
Removes all data from the signature field. More... | |
bool | ShowName (UTF8 &out_name) const |
Shows the name for the signature field. More... | |
bool | 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 signature field. More... | |
bool | ShowFontSize (int &out_size) const |
Shows the font size for the signature field. More... | |
bool | ShowTextColor (RGBColor &out_color) const |
Shows the text color for the signature field. More... | |
bool | ShowTooltip (UTF8 &out_tooltip) const |
Shows the tooltip for the signature field. More... | |
bool | ShowVisibility (bool &out_state) const |
Shows the visibility for the signature field. More... | |
bool | ShowPrintability (bool &out_state) const |
Shows the printability for the signature field. More... | |
bool | ShowTextRotation (Text::Rotation &out_rotation) const |
Shows the text rotation for the signature field. More... | |
bool | ShowLock (bool &out_state) const |
Shows the lock setting for the signature field. More... | |
bool | ShowBorder (bool &out_state) const |
Shows the border setting for the signature field. More... | |
bool | ShowBorderColor (RGBColor &out_color) const |
Shows the border color for the signature field. More... | |
bool | ShowBorderThickness (Border::Thickness &out_thickness) const |
Shows the border thickness for the signature field. More... | |
bool | ShowBorderStyle (Border::Style &out_style) const |
Shows the border style for the signature field. More... | |
bool | ShowFillColor (RGBColor &out_color) const |
Shows the fill color for the signature field. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
static SignatureFieldKit | GetDefault () |
Creates a SignatureFieldKit which contains the default settings. More... | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishSignatureFieldKit |
The SignatureFieldKit class is a user space object.
It acts as the container for all data that can be used to specify a signature field for a Publish PDF.
HPS::Publish::SignatureFieldKit::SignatureFieldKit | ( | ) |
The default constructor creates an empty SignatureFieldKit object.
HPS::Publish::SignatureFieldKit::SignatureFieldKit | ( | SignatureFieldKit const & | in_kit | ) |
The copy constructor creates a new SignatureFieldKit object that contains the same settings as the source SignatureFieldKit.
in_kit | The source SignatureFieldKit to copy. |
HPS::Publish::SignatureFieldKit::SignatureFieldKit | ( | SignatureFieldKit && | in_kit | ) |
The move constructor creates a SignatureFieldKit by transferring the underlying object of the rvalue reference to this SignatureFieldKit.
in_kit | An rvalue reference to a SignatureFieldKit to take the underlying object from. |
|
virtual |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
virtual |
Indicates whether this SignatureFieldKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::SignatureFieldKit::Equals | ( | SignatureFieldKit const & | in_kit | ) | const |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.
in_kit | The source SignatureFieldKit to compare to this SignatureFieldKit. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
static |
Creates a SignatureFieldKit 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 SignatureFieldKit passed to a function.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
bool HPS::Publish::SignatureFieldKit::operator!= | ( | SignatureFieldKit const & | in_kit | ) | const |
Check if the source SignatureFieldKit is not equivalent to this SignatureFieldKit.
in_kit | The source SignatureFieldKit to compare to this SignatureFieldKit. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::operator= | ( | SignatureFieldKit const & | in_kit | ) |
Copies the source SignatureFieldKit into this SignatureFieldKit.
in_kit | The source SignatureFieldKit to copy. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::operator= | ( | SignatureFieldKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this SignatureFieldKit.
in_kit | An rvalue reference to a SignatureFieldKit to take the underlying object from. |
bool HPS::Publish::SignatureFieldKit::operator== | ( | SignatureFieldKit const & | in_kit | ) | const |
Check if the source SignatureFieldKit is equivalent to this SignatureFieldKit.
in_kit | The source SignatureFieldKit to compare to this SignatureFieldKit. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::Publish::SignatureFieldKit::Set | ( | SignatureFieldKit const & | in_kit | ) |
Copies the source SignatureFieldKit into this SignatureFieldKit.
in_kit | The source SignatureFieldKit to copy. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorder | ( | bool | in_state | ) |
Sets whether the signature field has a border.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bHasBorder.
in_state | Whether the signature field has a border. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderColor | ( | RGBColor const & | in_color | ) |
Sets the border color for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sBorderColor.
in_color | The border color of the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderStyle | ( | Border::Style | in_style | ) |
Sets the border style for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eLineStyleBorder.
in_style | The border style for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetBorderThickness | ( | Border::Thickness | in_thickness | ) |
Sets the border thickness for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eThicknessBorder.
in_thickness | The border thickness for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFillColor | ( | RGBColor const & | in_color | ) |
Sets the fill color for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sFillColor and implicitly sets A3DPDFDigitalSignatureData::m_bHasFillColor to true.
in_color | The fill color for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFont | ( | Text::Font::Name | in_name | ) |
Sets a builtin font for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.
in_name | The builtin font for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFont | ( | char const * | in_name, |
Text::Font::Style | in_style = Text::Font::Style::Regular |
||
) |
Sets a specific font for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcFontName.
in_name | UTF8-encoded font name for the signature field. |
in_style | The style of font to use for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetFontSize | ( | int | in_size | ) |
Sets the font size for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_iFontSize.
in_size | The font size for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetLock | ( | bool | in_state | ) |
Sets whether the signature field is locked.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_bIsLocked.
in_state | Whether the signature field is locked. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetName | ( | char const * | in_name | ) |
Sets the name of the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcName.
in_name | UTF8-encoded name of the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetPrintability | ( | bool | in_state | ) |
Sets the printability for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.
in_state | The printability for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTextColor | ( | RGBColor const & | in_color | ) |
Sets the text color for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_sTextColor.
in_color | The text color for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTextRotation | ( | Text::Rotation | in_rotation | ) |
Sets the text rotation for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eTextOrientation.
in_rotation | The text rotation for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetTooltip | ( | char const * | in_tooltip | ) |
Sets the tooltip for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_pcTooltip.
in_tooltip | UTF8-encoded tooltip text for the signature field. |
SignatureFieldKit& HPS::Publish::SignatureFieldKit::SetVisibility | ( | bool | in_state | ) |
Sets the visibility for the signature field.
This corresponds to the value that will be passed to A3DPDFDigitalSignatureData::m_eFormField.
in_state | The visibility for the signature field. |
void HPS::Publish::SignatureFieldKit::Show | ( | SignatureFieldKit & | out_kit | ) | const |
Copies this SignatureFieldKit into the given SignatureFieldKit.
out_kit | The SignatureFieldKit to populate with the contents of this SignatureFieldKit. |
bool HPS::Publish::SignatureFieldKit::ShowBorder | ( | bool & | out_state | ) | const |
Shows the border setting for the signature field.
out_state | Whether the signature field has a border. |
bool HPS::Publish::SignatureFieldKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color for the signature field.
out_color | The border color of the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowBorderStyle | ( | Border::Style & | out_style | ) | const |
Shows the border style for the signature field.
out_style | The border style for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowBorderThickness | ( | Border::Thickness & | out_thickness | ) | const |
Shows the border thickness for the signature field.
out_thickness | The border thickness for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowFillColor | ( | RGBColor & | out_color | ) | const |
Shows the fill color for the signature field.
out_color | The fill color for the signature field. |
bool HPS::Publish::SignatureFieldKit::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 signature field.
out_type | The type of font for the signature field. |
out_font | The built-in font for the signature field. This is only valid if out_type is Text::Font::Type::BuiltIn. |
out_font_name | The explicit font name for the signature field. This is only valid if out_type is Text::Font::Type::Explicit. |
out_style | The font style for the signature field. This is only valid if out_type is Text::Font::Type::Explicit. |
bool HPS::Publish::SignatureFieldKit::ShowFontSize | ( | int & | out_size | ) | const |
Shows the font size for the signature field.
out_size | The font size for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowLock | ( | bool & | out_state | ) | const |
Shows the lock setting for the signature field.
in_state | Whether the signature field is locked. |
bool HPS::Publish::SignatureFieldKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name for the signature field.
out_name | The name of the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowPrintability | ( | bool & | out_state | ) | const |
Shows the printability for the signature field.
out_state | The printability for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowTextColor | ( | RGBColor & | out_color | ) | const |
Shows the text color for the signature field.
out_color | The text color for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowTextRotation | ( | Text::Rotation & | out_rotation | ) | const |
Shows the text rotation for the signature field.
out_rotation | The text rotation for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowTooltip | ( | UTF8 & | out_tooltip | ) | const |
Shows the tooltip for the signature field.
out_tooltip | The tooltip text for the signature field. |
bool HPS::Publish::SignatureFieldKit::ShowVisibility | ( | bool & | out_state | ) | const |
Shows the visibility for the signature field.
out_state | The visibility for the signature field. |
|
virtualinherited |
This function returns the true type of the underlying object.
This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorder | ( | ) |
Removes the border setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderStyle | ( | ) |
Removes the border style setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetBorderThickness | ( | ) |
Removes the border thickness setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetEverything | ( | ) |
Removes all data from the signature field.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFillColor | ( | ) |
Removes the fill color setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFont | ( | ) |
Removes the font setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetFontSize | ( | ) |
Removes the font size setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetLock | ( | ) |
Removes the lock setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetName | ( | ) |
Removes the name setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetPrintability | ( | ) |
Removes the printability setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTextColor | ( | ) |
Removes the text color setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTextRotation | ( | ) |
Removes the text rotation setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetTooltip | ( | ) |
Removes the tooltip setting.
SignatureFieldKit& HPS::Publish::SignatureFieldKit::UnsetVisibility | ( | ) |
Removes the visibility setting.
|
static |