HPS::Publish::LinkKit Class Reference

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::LinkKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (LinkKit const &in_kit) const
 
 LinkKit ()
 
 LinkKit (LinkKit const &in_kit)
 
 LinkKit (LinkKit &&in_kit)
 
HPS::Type ObjectType () const
 
bool operator!= (LinkKit const &in_kit) const
 
LinkKitoperator= (LinkKit const &in_kit)
 
LinkKitoperator= (LinkKit &&in_kit)
 
bool operator== (LinkKit const &in_kit) const
 
void Set (LinkKit const &in_kit)
 
LinkKitSetBorderColor (RGBColor const &in_color)
 
LinkKitSetBorderWidth (int in_width)
 
LinkKitSetHighlighting (Highlighting::Mode in_mode)
 
LinkKitSetJavaScript (char const *in_source, Source::Type in_type=Source::Type::Code)
 
void Show (LinkKit &out_kit) const
 
bool ShowBorderColor (RGBColor &out_color) const
 
bool ShowBorderWidth (int &out_width) const
 
bool ShowHighlighting (Highlighting::Mode &out_mode) const
 
bool ShowJavaScript (UTF8 &out_source, Source::Type &out_type) const
 
LinkKitUnsetBorderColor ()
 
LinkKitUnsetBorderWidth ()
 
LinkKitUnsetEverything ()
 
LinkKitUnsetHighlighting ()
 
LinkKitUnsetJavaScript ()
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishLinkKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

The LinkKit class is a user space object. It acts as the container for all data that can be used to specify a link for a Publish PDF.

Constructor & Destructor Documentation

◆ LinkKit() [1/3]

HPS::Publish::LinkKit::LinkKit ( )

The default constructor creates an empty LinkKit object.

◆ LinkKit() [2/3]

HPS::Publish::LinkKit::LinkKit ( LinkKit const &  in_kit)

The copy constructor creates a new LinkKit object that contains the same settings as the source LinkKit.

Parameters
in_kitThe source LinkKit to copy.

◆ LinkKit() [3/3]

HPS::Publish::LinkKit::LinkKit ( LinkKit &&  in_kit)

The move constructor creates a LinkKit by transferring the underlying object of the rvalue reference to this LinkKit.

Parameters
in_kitAn rvalue reference to a LinkKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Publish::LinkKit::Empty ( ) const
virtual

Indicates whether this LinkKit has any values set on it.

Returns
true if no values are set on this LinkKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Publish::LinkKit::Equals ( LinkKit const &  in_kit) const

Check if the source LinkKit is equivalent to this LinkKit.

Parameters
in_kitThe source LinkKit to compare to this LinkKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::Publish::LinkKit::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::LinkKit::operator!= ( LinkKit const &  in_kit) const

Check if the source LinkKit is not equivalent to this LinkKit.

Parameters
in_kitThe source LinkKit to compare to this LinkKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

LinkKit& HPS::Publish::LinkKit::operator= ( LinkKit const &  in_kit)

Copies the source LinkKit into this LinkKit.

Parameters
in_kitThe source LinkKit to copy.
Returns
A reference to this LinkKit.

◆ operator=() [2/2]

LinkKit& HPS::Publish::LinkKit::operator= ( LinkKit &&  in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this LinkKit.

Parameters
in_kitAn rvalue reference to a LinkKit to take the underlying object from.
Returns
A reference to this LinkKit.

◆ operator==()

bool HPS::Publish::LinkKit::operator== ( LinkKit const &  in_kit) const

Check if the source LinkKit is equivalent to this LinkKit.

Parameters
in_kitThe source LinkKit to compare to this LinkKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::LinkKit::Set ( LinkKit const &  in_kit)

Copies the source LinkKit into this LinkKit.

Parameters
in_kitThe source LinkKit to copy.

◆ SetBorderColor()

LinkKit& HPS::Publish::LinkKit::SetBorderColor ( RGBColor const &  in_color)

Sets the color of the border for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor.

Parameters
in_colorThe color of the border for the link.
Returns
A reference to this LinkKit.

◆ SetBorderWidth()

LinkKit& HPS::Publish::LinkKit::SetBorderWidth ( int  in_width)

Sets the border width in points for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_iBorderWidth.

Parameters
in_widthThe border width in points for the link.
Returns
A reference to this LinkKit.

◆ SetHighlighting()

LinkKit& HPS::Publish::LinkKit::SetHighlighting ( Highlighting::Mode  in_mode)

Sets the highlighting mode for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_eHighlightingMode.

Parameters
in_modeThe highlighting mode for the link.
Returns
A reference to this LinkKit.

◆ SetJavaScript()

LinkKit& HPS::Publish::LinkKit::SetJavaScript ( char const *  in_source,
Source::Type  in_type = Source::Type::Code 
)

Sets the JavaScript source or file for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_pcJavascriptString.

Parameters
in_sourceThe JavaScript source or file (depending on the next argument) for the link.
in_typeThe type of the preceding argument. Defaults to Source::Type::Code.
Returns
A reference to this LinkKit.

◆ Show()

void HPS::Publish::LinkKit::Show ( LinkKit out_kit) const

Copies this LinkKit into the given LinkKit.

Parameters
out_kitThe LinkKit to populate with the contents of this LinkKit.

◆ ShowBorderColor()

bool HPS::Publish::LinkKit::ShowBorderColor ( RGBColor out_color) const

Shows the border color setting.

Parameters
out_colorThe border color of the link.
Returns
true if a border color was specified, false otherwise.

◆ ShowBorderWidth()

bool HPS::Publish::LinkKit::ShowBorderWidth ( int &  out_width) const

Shows the border width setting.

Parameters
out_widthThe border width of the link.
Returns
true if a border width was specified, false otherwise.

◆ ShowHighlighting()

bool HPS::Publish::LinkKit::ShowHighlighting ( Highlighting::Mode out_mode) const

Shows the highlighting mode setting.

Parameters
out_modeThe highlighting mode of the link.
Returns
true if a highlighting mode was specified, false otherwise.

◆ ShowJavaScript()

bool HPS::Publish::LinkKit::ShowJavaScript ( UTF8 out_source,
Source::Type out_type 
) const

Shows the JavaScript setting.

Parameters
out_sourceThe JavaScript source or file (depending on the next argument) for the link.
out_typeThe type of the preceding argument.
Returns
true if a JavaScript source or file was specified, false otherwise.

◆ UnsetBorderColor()

LinkKit& HPS::Publish::LinkKit::UnsetBorderColor ( )

Removes the border color setting.

Returns
A reference to this LinkKit.

◆ UnsetBorderWidth()

LinkKit& HPS::Publish::LinkKit::UnsetBorderWidth ( )

Removes the border width setting.

Returns
A reference to this LinkKit.

◆ UnsetEverything()

LinkKit& HPS::Publish::LinkKit::UnsetEverything ( )

Removes all data from the link.

Returns
A reference to this LinkKit.

◆ UnsetHighlighting()

LinkKit& HPS::Publish::LinkKit::UnsetHighlighting ( )

Removes the highlighting mode setting.

Returns
A reference to this LinkKit.

◆ UnsetJavaScript()

LinkKit& HPS::Publish::LinkKit::UnsetJavaScript ( )

Removes the JavaScript setting.

Returns
A reference to this LinkKit.

The documentation for this class was generated from the following file: