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

#include <edl/idomtarget.h>

Inheritance diagram for IDOMPageTarget:

Public Member Functions
	DECLARE_CLASS_ID (IDOMPageTargetClassID)
virtual uint32	getTargetPage () const =0
	Retrieves the target page number for a page target. A page target has the whole page as the target. It refers to a page using the absolute page number within the document sequence, where the very first page in the first document is number 1.
virtual void	setTargetPage (uint32 page)=0
	Sets the target page number for a page target. A page target has the whole page as the target. It refers to a page using the absolute page number within the document sequence, where the very first page in the first document is number 1.
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.

Additional Inherited Members
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...
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

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

Member Function Documentation

◆ DECLARE_CLASS_ID()

IDOMPageTarget::DECLARE_CLASS_ID ( IDOMPageTargetClassID )

◆ getTargetPage()

virtual uint32 IDOMPageTarget::getTargetPage ( ) const

pure virtual

Retrieves the target page number for a page target. A page target has the whole page as the target. It refers to a page using the absolute page number within the document sequence, where the very first page in the first document is number 1.

Returns: uint32 The target page number.

◆ getTargetType()

virtual eTargetType IDOMPageTarget::getTargetType ( ) const

inlinevirtual

Implementation of getTargetType for IDOMPageTarget.

Returns: eTargetType. Returns "ePage".

Implements IDOMTarget.

◆ setTargetPage()

virtual void IDOMPageTarget::setTargetPage ( uint32 page )

pure virtual

Sets the target page number for a page target. A page target has the whole page as the target. It refers to a page using the absolute page number within the document sequence, where the very first page in the first document is number 1.

Parameters

page	The new target page number.

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

edl/idomtarget.h