IHyperlink Class Reference

Inheritance diagram for IHyperlink:

Public Types
enum	{ kDefaultIID = IID_IHYPERLINK }

Public Member Functions
virtual void	GetName (PMString *pName) const =0
virtual void	SetName (const PMString &newName)=0
virtual void	GetDisplayName (PMString *pName) const =0
virtual void	SetDisplayName (const PMString &newName)=0
virtual const UID &	GetSourceUID () const =0
virtual UID	GetDestinationUID () const =0
virtual uint32	GetDestinationUniqueKey () const =0
virtual void	SetSourceUID (const UID newSourceUID)=0
virtual void	SetDestinationUniqueKey (uint32 newDestKey)=0
virtual void	SetHidden (bool16 bIsHidden)=0
virtual bool16	IsHidden () const =0
virtual void	SetExternalDestination (bool16 bIsDestinationExternal)=0
virtual bool16	IsExternalDestination () const =0
virtual bool16	IsDestInExternalFile () const =0
virtual void	GoToSource () const =0
virtual void	GoToDestination () const =0
virtual void	GetIcon (RsrcID *iconID, PluginID *pluginID) const =0
virtual void	SetIcon (RsrcID iconID, PluginID pluginID)=0
virtual bool16	IsUnresolvedLink () const =0
virtual bool16	destInHiddenLayer () const =0
virtual bool16	IsOutOfDateLink () const =0
virtual UIDRef	GetDestinationUIDRef () 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 bool16 IHyperlink::destInHiddenLayer ( ) const

pure virtual

Returns kTrue if the destination is in hidden layer

virtual UID IHyperlink::GetDestinationUID ( ) const

pure virtual

Deprecated:

This API is deprecated, don't use it! USE SAFER GetDestinationUIDRef

virtual UIDRef IHyperlink::GetDestinationUIDRef ( ) const

pure virtual

Get the UID of the destination this hyperlink points to

Returns

UID - UID of the destination

virtual uint32 IHyperlink::GetDestinationUniqueKey ( ) const

pure virtual

Get the unique key of the destination this hyperlink points to

Returns

uint32 - unique key of the destination

virtual void IHyperlink::GetDisplayName ( PMString *  pName ) const

pure virtual

Get the display name of the hyperlink for UI (Translated)

Parameters

*pName

- Pointer that will be filled with the name

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

pure virtual

For getting the destination Icons

Parameters

*iconID	- ID of the Icon
*pluginID	- ID of the plugin

virtual void IHyperlink::GetName ( PMString *  pName ) const

pure virtual

Get the name of the hyperlink (Translated)

Parameters

*pName

- Pointer that will be filled with the name

virtual const UID& IHyperlink::GetSourceUID ( ) const

pure virtual

Get the UID of the source this hyperlink points to

Parameters

none

Returns

const UID& - UID of the source

virtual void IHyperlink::GoToDestination ( ) const

pure virtual

Show the hyperlink Destination

Parameters

none

virtual void IHyperlink::GoToSource ( ) const

pure virtual

Show the Hyperlink Source

Parameters

none

virtual bool16 IHyperlink::IsDestInExternalFile ( ) const

pure virtual

Get whether the destination file is external to this document or not

Parameters

none

Returns

bool16 - kTrue means the destination file is another document

virtual bool16 IHyperlink::IsExternalDestination ( ) const

pure virtual

Get whether the destination is external to this document or not

Parameters

none

Returns

bool16 - kTrue means the destination is in another document

virtual bool16 IHyperlink::IsHidden ( ) const

pure virtual

Get whether or not this hyperlink is hidden in the UI

Parameters

none

Returns

bool16 - kTrue = Hidden in the UI

virtual bool16 IHyperlink::IsOutOfDateLink ( ) const

pure virtual

Returns kTrue if x-ref source is out of date

virtual bool16 IHyperlink::IsUnresolvedLink ( ) const

pure virtual

Returns kTrue if this is an destination marker or file is missing

virtual void IHyperlink::SetDestinationUniqueKey ( uint32  newDestKey )

pure virtual

Set the unique key of the destination this hyperlink points to

Parameters

newDestKey

- unique key of the destination

virtual void IHyperlink::SetDisplayName ( const PMString &  newName )

pure virtual

Set the display name of the hyperlink for UI

Parameters

newName

- Name to use

virtual void IHyperlink::SetExternalDestination ( bool16  bIsDestinationExternal )

pure virtual

Set whether the destination is external to this document or not

Parameters

bIsDestinationExternal

- kTrue means the destination is in another document

virtual void IHyperlink::SetHidden ( bool16  bIsHidden )

pure virtual

Set whether or not this hyperlink is hidden in the UI

Parameters

bIsHidden

- kTrue == Hide in the UI

virtual void IHyperlink::SetIcon ( RsrcID  iconID, PluginID  pluginID  )

pure virtual

For setting the destination Icons

Parameters

iconID	- ID of the Icon
pluginID	- ID of the plugin

virtual void IHyperlink::SetName ( const PMString &  newName )

pure virtual

Set the name of the hyperlink

Parameters

newName

- Name to use

virtual void IHyperlink::SetSourceUID ( const UID  newSourceUID )

pure virtual

Set the UID of the source this hyperlink points to

Parameters

newSourceUID

- UID of the source