#include <sprk_publish.h>

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 |
LinkKit & | operator= (LinkKit const &in_kit) |
LinkKit & | operator= (LinkKit &&in_kit) |
bool | operator== (LinkKit const &in_kit) const |
void | Set (LinkKit const &in_kit) |
LinkKit & | SetBorderColor (RGBColor const &in_color) |
LinkKit & | SetBorderWidth (int in_width) |
LinkKit & | SetHighlighting (Highlighting::Mode in_mode) |
LinkKit & | SetJavaScript (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 |
LinkKit & | UnsetBorderColor () |
LinkKit & | UnsetBorderWidth () |
LinkKit & | UnsetEverything () |
LinkKit & | UnsetHighlighting () |
LinkKit & | UnsetJavaScript () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishLinkKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketKit & | operator= (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
HPS::Publish::LinkKit::LinkKit | ( | ) |
The default constructor creates an empty LinkKit object.
HPS::Publish::LinkKit::LinkKit | ( | LinkKit const & | in_kit | ) |
HPS::Publish::LinkKit::LinkKit | ( | LinkKit && | in_kit | ) |
Member Function Documentation
|
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.
bool HPS::Publish::LinkKit::Equals | ( | LinkKit const & | in_kit | ) | const |
bool HPS::Publish::LinkKit::operator!= | ( | LinkKit const & | in_kit | ) | const |
bool HPS::Publish::LinkKit::operator== | ( | LinkKit const & | in_kit | ) | const |
void HPS::Publish::LinkKit::Set | ( | LinkKit const & | in_kit | ) |
Sets the color of the border for the link. This corresponds to the value that will be passed to A3DPDFLinkData::m_sColor.
- Parameters
-
in_color The color of the border for the link.
- Returns
- A reference to this LinkKit.
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_width The border width in points for the link.
- Returns
- A reference to this LinkKit.
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_mode The highlighting mode for the link.
- Returns
- A reference to this LinkKit.
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_source The JavaScript source or file (depending on the next argument) for the link. in_type The type of the preceding argument. Defaults to Source::Type::Code.
- Returns
- A reference to this LinkKit.
void HPS::Publish::LinkKit::Show | ( | LinkKit & | out_kit | ) | const |
bool HPS::Publish::LinkKit::ShowBorderColor | ( | RGBColor & | out_color | ) | const |
Shows the border color setting.
- Parameters
-
out_color The border color of the link.
- Returns
- true if a border color was specified, false otherwise.
bool HPS::Publish::LinkKit::ShowBorderWidth | ( | int & | out_width | ) | const |
Shows the border width setting.
- Parameters
-
out_width The border width of the link.
- Returns
- true if a border width was specified, false otherwise.
bool HPS::Publish::LinkKit::ShowHighlighting | ( | Highlighting::Mode & | out_mode | ) | const |
Shows the highlighting mode setting.
- Parameters
-
out_mode The highlighting mode of the link.
- Returns
- true if a highlighting mode was specified, false otherwise.
bool HPS::Publish::LinkKit::ShowJavaScript | ( | UTF8 & | out_source, |
Source::Type & | out_type | ||
) | const |
Shows the JavaScript setting.
- Parameters
-
out_source The JavaScript source or file (depending on the next argument) for the link. out_type The type of the preceding argument.
- Returns
- true if a JavaScript source or file was specified, false otherwise.
LinkKit& HPS::Publish::LinkKit::UnsetBorderColor | ( | ) |
Removes the border color setting.
- Returns
- A reference to this LinkKit.
LinkKit& HPS::Publish::LinkKit::UnsetBorderWidth | ( | ) |
Removes the border width setting.
- Returns
- A reference to this LinkKit.
LinkKit& HPS::Publish::LinkKit::UnsetEverything | ( | ) |
Removes all data from the link.
- Returns
- A reference to this LinkKit.
LinkKit& HPS::Publish::LinkKit::UnsetHighlighting | ( | ) |
Removes the highlighting mode setting.
- Returns
- A reference to this LinkKit.
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:
- include/sprk_publish.h