HPS::Publish::LinkKit Class Reference

The LinkKit class is a user space object. More...

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::LinkKit:

Collaboration diagram for HPS::Publish::LinkKit:

Public Member Functions
	LinkKit ()
	The default constructor creates an empty LinkKit object. More...
	LinkKit (LinkKit const &in_kit)
	The copy constructor creates a new LinkKit object that contains the same settings as the source LinkKit. More...
	LinkKit (LinkKit &&in_kit)
	The move constructor creates a LinkKit by transferring the underlying object of the rvalue reference to this LinkKit. More...
virtual	~LinkKit ()
HPS::Type	ObjectType () const
void	Set (LinkKit const &in_kit)
	Copies the source LinkKit into this LinkKit. More...
void	Show (LinkKit &out_kit) const
	Copies this LinkKit into the given LinkKit. More...
LinkKit &	operator= (LinkKit const &in_kit)
	Copies the source LinkKit into this LinkKit. More...
LinkKit &	operator= (LinkKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to this LinkKit. More...
bool	Empty () const
	Indicates whether this LinkKit has any values set on it. More...
bool	Equals (LinkKit const &in_kit) const
	Check if the source LinkKit is equivalent to this LinkKit. More...
bool	operator== (LinkKit const &in_kit) const
	Check if the source LinkKit is equivalent to this LinkKit. More...
bool	operator!= (LinkKit const &in_kit) const
	Check if the source LinkKit is not equivalent to this LinkKit. More...
LinkKit &	SetJavaScript (char const *in_source, Source::Type in_type=Source::Type::Code)
	Sets the JavaScript source or file for the link. More...
LinkKit &	SetBorderWidth (int in_width)
	Sets the border width in points for the link. More...
LinkKit &	SetHighlighting (Highlighting::Mode in_mode)
	Sets the highlighting mode for the link. More...
LinkKit &	SetBorderColor (RGBColor const &in_color)
	Sets the color of the border for the link. More...
LinkKit &	UnsetJavaScript ()
	Removes the JavaScript setting. More...
LinkKit &	UnsetBorderWidth ()
	Removes the border width setting. More...
LinkKit &	UnsetHighlighting ()
	Removes the highlighting mode setting. More...
LinkKit &	UnsetBorderColor ()
	Removes the border color setting. More...
LinkKit &	UnsetEverything ()
	Removes all data from the link. More...
bool	ShowJavaScript (UTF8 &out_source, Source::Type &out_type) const
	Shows the JavaScript setting. More...
bool	ShowBorderWidth (int &out_width) const
	Shows the border width setting. More...
bool	ShowHighlighting (Highlighting::Mode &out_mode) const
	Shows the highlighting mode setting. More...
bool	ShowBorderColor (RGBColor &out_color) const
	Shows the border color setting. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PublishLinkKit

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_kit

The 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_kit

An rvalue reference to a LinkKit to take the underlying object from.

~LinkKit()

virtual HPS::Publish::LinkKit::~LinkKit ( )

virtual

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

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.

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_kit

The source LinkKit to compare to this LinkKit.

Returns

true if the objects are equivalent, false otherwise.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

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.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::Publish::LinkKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::LinkKit::operator!=

(

LinkKit const &

in_kit

)

const

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

Parameters

in_kit

The 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_kit

The 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_kit

An 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_kit

The source LinkKit to compare to this LinkKit.

Returns

true if the objects are equivalent, false otherwise.

Reset()

virtual void HPS::Object::Reset ( )

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.

Set()

void HPS::Publish::LinkKit::Set

(

LinkKit const &

in_kit

)

Copies the source LinkKit into this LinkKit.

Parameters

in_kit

The 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_color

The 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_width

The 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_mode

The 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_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.

Show()

void HPS::Publish::LinkKit::Show

(

LinkKit &

out_kit

)

const

Copies this LinkKit into the given LinkKit.

Parameters

out_kit

The 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_color

The 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_width

The 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_mode

The 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_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.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

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.

Returns

The true type of the object in question.

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.

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.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::LinkKit::staticType = HPS::Type::PublishLinkKit

static

---

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

• sprk_publish.h