Inheritance diagram for IHyperlinkDestination:

Public Types
enum	{ kDefaultIID = IID_IHYPERLINKDESTINATION }

enum	DestType { kTextAnchorDestination = 0, kPageDestination, kURLDestination, kExternalPageDestination }

Public Member Functions
virtual void	GoToHyperlinkDestination () const =0

virtual void	SetHidden (bool16 bIsHidden)=0

virtual bool16	IsHidden () const =0

virtual void	GetName (PMString *destName) const =0

virtual void	SetName (const PMString &destName)=0

virtual uint32	GetKey () const =0

virtual void	SetKey (uint32 destKey)=0

virtual void	GetIcon (RsrcID iconID, PluginID pluginID)=0

virtual void	GetType (PMString *destType) const =0

virtual DestType	GetType () const =0

virtual void	GetInfo (PMString *destInfo) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual void IHyperlinkDestination::GetIcon	(	RsrcID *	iconID,
		PluginID *	pluginID
	)

pure virtual

Get an icon to give a pictoral representation of this destination to the user

Parameters

*iconID	- Will be filled with the ID of the icon to use
*pluginID	- Will be filled with the ID of the panel to use

virtual void IHyperlinkDestination::GetInfo ( PMString * destInfo ) const

pure virtual

Get information about this destination (Page it is on, URL it points to, etc)

Parameters

destInfo - Will be filled with the information

virtual uint32 IHyperlinkDestination::GetKey ( ) const

pure virtual

Get the destination key

Returns: uint32 - destination unique key value

virtual void IHyperlinkDestination::GetName ( PMString * destName ) const

pure virtual

Get the destination name

Parameters

destName - Will be filled with the name

virtual void IHyperlinkDestination::GetType ( PMString * destType ) const

pure virtual

Get this destination's type as a string

Parameters

destType - ("Page", "Text Anchor", "URL")

virtual DestType IHyperlinkDestination::GetType ( ) const

pure virtual

Get this destination's type as an enum

Returns: DestType - type of the destination

virtual void IHyperlinkDestination::GoToHyperlinkDestination ( ) const

pure virtual

Show the destination in the Layout Window

Parameters

none

virtual bool16 IHyperlinkDestination::IsHidden ( ) const

pure virtual

Get whether this destination should be visible in the UI (panel)

Parameters

none

Returns: bool16 - kTrue == Hidden

virtual void IHyperlinkDestination::SetHidden ( bool16 bIsHidden )

pure virtual

Set whether this destination should be visible in the UI (panel)

Parameters

bIsHidden - kTrue == Hidden

virtual void IHyperlinkDestination::SetKey ( uint32 destKey )

pure virtual

Set the destination unique key

Parameters

destKey - The new key of the destination

virtual void IHyperlinkDestination::SetName ( const PMString & destName )

pure virtual

Set the destination name

Parameters

destName - The new name of the destination

Public Types

Public Member Functions

Member Function Documentation