IDOMPageRectTarget nodes are used to describe hyperlinks on a page rectangle to targets on the same page. More...

#include <edl/idomtarget.h>

Inheritance diagram for IDOMPageRectTarget:

Public Types
enum	eFitType { eFTInvalid , eFTXyz , eFTFit , eFTFitH , eFTFitV , eFTFitR , eFTFitB , eFTFitBH , eFTFitBV }
	Destination fit types enumeration. More...
Public Types inherited from IDOMTarget
enum	eTargetType { eExternal , eInternal , ePage , ePageRect , eActionGoToR , eActionGoToE , eActionLaunch , eActionThread , eActionSound , eActionMovie , eActionHide , eActionNamed , eActionSubmitForm , eActionResetForm , eActionImportData , eActionJavaScript , eActionSetOCGState , eActionRendition , eActionTrans , eActionGoTo3DView , eActionArray }
	An enumeration of target types. More...

Public Member Functions
	DECLARE_CLASS_ID (IDOMPageRectTargetClassID)
virtual DOMid	getPageId () const =0
	Retrieves the target page DOM id.
virtual void	setPageId (DOMid domId)=0
	Sets the target page DOM id.
virtual eFitType	getFitType () const =0
	Retrieves the fit type. See eFitType.
virtual void	setFitType (eFitType fitType)=0
	Sets the fit type. See eFitType.
virtual double	getZoom () const =0
	Retrieves the zoom value.
virtual void	setZoom (double zoom)=0
	Sets for the zoom value.
virtual doubleWithNull	getLeft () const =0
	Gets the left coordinate value of the target.
virtual void	setLeft (const doubleWithNull &left)=0
	Sets the left coordinate value of the target.
virtual doubleWithNull	getTop () const =0
	Gets the top coordinate value of the target.
virtual void	setTop (const doubleWithNull &top)=0
	Sets the top coordinate value of the target.
virtual doubleWithNull	getRight () const =0
	Gets the right coordinate value of the target.
virtual void	setRight (const doubleWithNull &right)=0
	Sets the right coordinate value of the target.
virtual doubleWithNull	getBottom () const =0
	Gets the bottom coordinate value of the target.
virtual void	setBottom (const doubleWithNull &bottom)=0
	Sets the bottom coordinate value of the target.
virtual eTargetType	getTargetType () const
	Implementation of getTargetType for IDOMPageTarget.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static EDL_API IDOMPageRectTargetPtr	create (IEDLClassFactory *pFactory, DOMid pageId, eFitType fitType=eFTFit, double zoom=0.0, const doubleWithNull &left=doubleWithNull(), const doubleWithNull &top=doubleWithNull(), const doubleWithNull &right=doubleWithNull(), const doubleWithNull &bottom=doubleWithNull())
	Simplified creator for a page rect target. Throws an exception of type IEDLError on failure.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMPageRectTarget nodes are used to describe hyperlinks on a page rectangle to targets on the same page.

Member Function Documentation

◆ create()

EDL_API IDOMPageRectTargetPtr IDOMPageRectTarget::create	(	IEDLClassFactory *	pFactory,
		DOMid	pageId,
		eFitType	fitType = eFTFit,
		double	zoom = 0.0,
		const doubleWithNull &	left = doubleWithNull(),
		const doubleWithNull &	top = doubleWithNull(),
		const doubleWithNull &	right = doubleWithNull(),
		const doubleWithNull &	bottom = doubleWithNull() )

static

Simplified creator for a page rect target. Throws an exception of type IEDLError on failure.

Parameters

pFactory	The EDL factory to use
pageId	The DOM id of the target page
fitType	The fit type
zoom	The desired zoom level. Zero indicates that the zoom should be unchanged when navigating to this target.
left	The left of the target rect. For certain fit types, this will be ignored.
top	The top of the target rect. For certain fit types, this will be ignored.
right	The right of the target rect. For certain fit types, this will be ignored.
bottom	The left of the target rect. For certain fit types, this will be ignored.

Returns: IDOMPageRectTarget The new target

◆ DECLARE_CLASS_ID()

IDOMPageRectTarget::DECLARE_CLASS_ID ( IDOMPageRectTargetClassID )

◆ getBottom()

virtual doubleWithNull IDOMPageRectTarget::getBottom ( ) const

pure virtual

Gets the bottom coordinate value of the target.

Returns: doubleWithNull Returns the bottom coordinate value of the target.

◆ getFitType()

virtual eFitType IDOMPageRectTarget::getFitType ( ) const

pure virtual

Retrieves the fit type. See eFitType.

Returns: eFitType Returns the fit type.

◆ getLeft()

virtual doubleWithNull IDOMPageRectTarget::getLeft ( ) const

pure virtual

Gets the left coordinate value of the target.

Returns: doubleWithNull Returns the left coordinate value of the target.

◆ getPageId()

virtual DOMid IDOMPageRectTarget::getPageId ( ) const

pure virtual

Retrieves the target page DOM id.

Returns: DOMid The target page id

◆ getRight()

virtual doubleWithNull IDOMPageRectTarget::getRight ( ) const

pure virtual

Gets the right coordinate value of the target.

Returns: doubleWithNull Returns the right coordinate value of the target.

◆ getTargetType()

virtual eTargetType IDOMPageRectTarget::getTargetType ( ) const

inlinevirtual

Implementation of getTargetType for IDOMPageTarget.

Returns: eTargetType. Returns "ePage".

Implements IDOMTarget.

◆ getTop()

virtual doubleWithNull IDOMPageRectTarget::getTop ( ) const

pure virtual

Gets the top coordinate value of the target.

Returns: doubleWithNull Returns the top coordinate value of the target.

◆ getZoom()

virtual double IDOMPageRectTarget::getZoom ( ) const

pure virtual

Retrieves the zoom value.

Returns: double The zoom value.

A zoom value of zero specifies that the current value of that parameter is to be retained unchanged

◆ setBottom()

virtual void IDOMPageRectTarget::setBottom ( const doubleWithNull & bottom )

pure virtual

Sets the bottom coordinate value of the target.

Parameters

bottom The new bottom coordinate value.

◆ setFitType()

virtual void IDOMPageRectTarget::setFitType ( eFitType fitType )

pure virtual

Sets the fit type. See eFitType.

Parameters

fitType The new fit type.

◆ setLeft()

virtual void IDOMPageRectTarget::setLeft ( const doubleWithNull & left )

pure virtual

Sets the left coordinate value of the target.

Parameters

left	The new left coordinate value.

◆ setPageId()

virtual void IDOMPageRectTarget::setPageId ( DOMid domId )

pure virtual

Sets the target page DOM id.

Parameters

domId The new target page id

◆ setRight()

virtual void IDOMPageRectTarget::setRight ( const doubleWithNull & right )

pure virtual

Sets the right coordinate value of the target.

Parameters

right The new right coordinate value.

◆ setTop()

virtual void IDOMPageRectTarget::setTop ( const doubleWithNull & top )

pure virtual

Sets the top coordinate value of the target.

Parameters

top	The new top coordinate value.

◆ setZoom()

virtual void IDOMPageRectTarget::setZoom ( double zoom )

pure virtual

Sets for the zoom value.

Parameters

zoom	The new zoom value.

A zoom value of zero specifies that the current value of that parameter is to be retained unchanged.

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

edl/idomtarget.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ DECLARE_CLASS_ID()

◆ getBottom()

◆ getFitType()

◆ getLeft()

◆ getPageId()

◆ getRight()

◆ getTargetType()

◆ getTop()

◆ getZoom()

◆ setBottom()

◆ setFitType()

◆ setLeft()

◆ setPageId()

◆ setRight()

◆ setTop()

◆ setZoom()