OdPdfPublish::OdLink Class Reference

#include <PdfPublishLink.h>

Inheritance diagram for OdPdfPublish::OdLink:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdLink)
	ODRX_HEAP_OPERATORS ()
virtual	~OdLink ()
void	setJavaScript (const OdString &source, const Source::Type source_type=Source::kCode)
void	setBorderWidth (const OdUInt16 width)
void	setHighlighting (const Highlighting::Mode mode)
void	setBorderColor (const ODCOLORREF color)
void	getJavaScript (OdString &source, Source::Type &source_type) const
void	getBorderWidth (OdUInt16 &width) const
void	getHighlighting (Highlighting::Mode &mode) const
void	getBorderColor (ODCOLORREF &color) const
Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)
	ODRX_HEAP_OPERATORS ()
virtual	~OdObject ()
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	clear ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
	OdLink ()
Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class implements a link control contained in a .pdf document created with Publish SDK.

Definition at line 45 of file PdfPublishLink.h.

Constructor & Destructor Documentation

OdLink()

OdPdfPublish::OdLink::OdLink ( )

protected

~OdLink()

virtual OdPdfPublish::OdLink::~OdLink ( )

virtual

Destroys the link control.

Member Function Documentation

getBorderColor()

void OdPdfPublish::OdLink::getBorderColor

(

ODCOLORREF &

color

)

const

Returns the link control border color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the border color value.

getBorderWidth()

void OdPdfPublish::OdLink::getBorderWidth

(

OdUInt16 &

width

)

const

Returns the current border width of the link control. The method fills a passed value and returns it to a calling subroutine.

Parameters

width

[out] A placeholder for the border width value (in points).

Remarks

Border width is measured in points.

getHighlighting()

void OdPdfPublish::OdLink::getHighlighting

(

Highlighting::Mode &

mode

)

const

Returns the current link highlighting mode. The method fills a passed value with the current highlighting mode and returns it to a calling subroutine.

Parameters

mode	[out] A placeholder for the highlighting mode value.

See also

<link OdPdfPublish::Highlighting::Mode, Highlighting::Mode enumeration>.

getJavaScript()

void OdPdfPublish::OdLink::getJavaScript	(	OdString &	source,
		Source::Type &	source_type
	)		const

Returns the current JavaScript scenario for the link control. The method fills a passed string object with the JavaScript scenario source code and returns it to a calling subroutine.

Parameters

source	[out] A placeholder for the JavaScript scenario source code.
source_type	[out] A placeholder for the JavaScript source code type.

See also

<link OdPdfPublish::Source::Type, Source::Type enumeration>.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdLink::ODRX_DECLARE_MEMBERS

(

OdLink

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdLink::ODRX_HEAP_OPERATORS

(

)

setBorderColor()

void OdPdfPublish::OdLink::setBorderColor

(

const ODCOLORREF

color

)

Sets the link control border color.

Parameters

color

[in] A new value of the border color.

setBorderWidth()

void OdPdfPublish::OdLink::setBorderWidth

(

const OdUInt16

width

)

Sets the border width of the link control. Border width is measured in points.

Parameters

width

[in] A border width value (in points).

setHighlighting()

void OdPdfPublish::OdLink::setHighlighting

(

const Highlighting::Mode

mode

)

Sets the link highlighting mode.

Parameters

mode	[in] A new highlighting mode for the link.

See also

<link OdPdfPublish::Highlighting::Mode, Highlighting::Mode enumeration>.

setJavaScript()

void OdPdfPublish::OdLink::setJavaScript	(	const OdString &	source,
		const Source::Type	source_type = Source::kCode
	)

Sets a JavaScript scenario for the link control.

Parameters

source	[in] A string object that contains the JavaScript scenario source code.
source_type	[in] A JavaScript scenario source code type.

See also

<link OdPdfPublish::Source::Type, Source::Type enumeration>.

---

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

• PdfPublishLink.h