InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IHyperlinkSource Class Referenceabstract

#include <IHyperlinkSource.h>

Inheritance diagram for IHyperlinkSource:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPERLINKSOURCE }
 

Public Member Functions

virtual void GoToHyperlinkSource () const =0
 
virtual void GetName (PMString *pName) const =0
 
virtual void SetName (const PMString &newName)=0
 
virtual void SetHidden (bool16 bIsHidden)=0
 
virtual bool16 IsHidden () const =0
 
virtual void SetOwningHyperlink (UID owningHyperlink)=0
 
virtual UID GetOwningHyperlink () const =0
 
virtual void SetBookmarkUID (UID bookmarkUID)=0
 
virtual UID GetBookmarkUID () 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
 

Detailed Description

See Also
kHyperlinkTextSourceBoss
kHyperlinkTextSourceBoss

Member Function Documentation

virtual UID IHyperlinkSource::GetBookmarkUID () const
pure virtual

Get the UID of the bookmark that is associated with this source

Parameters
none
Returns
UID - UID of the bookmark (kInvalid is possible)
virtual void IHyperlinkSource::GetName (PMString * pName) const
pure virtual

Get the name of this source

Parameters
*pName- Will be filled with the name of this source
virtual UID IHyperlinkSource::GetOwningHyperlink () const
pure virtual

Get the UID of the hyperlink that "owns" this source

Parameters
none
Returns
UID - UID of the hyperlink
virtual void IHyperlinkSource::GoToHyperlinkSource () const
pure virtual

Show this source in the layout window

Parameters
none
virtual bool16 IHyperlinkSource::IsHidden () const
pure virtual

Get whether or not this source is hidden in the UI (Panel)

Parameters
none
Returns
bool16 - kTrue == Hidden
virtual void IHyperlinkSource::SetBookmarkUID (UID bookmarkUID)
pure virtual

Set the UID of the bookmark that is associated with this source (Used by TOC)

Parameters
bookmarkUID- UID of the bookmark (kInvalid is possible)
virtual void IHyperlinkSource::SetHidden (bool16 bIsHidden)
pure virtual

Set whether or not this source is hidden in the UI (Panel)

Parameters
bIsHidden- kTrue == Hidden
virtual void IHyperlinkSource::SetName (const PMString & newName)
pure virtual

Set the name of this source

Parameters
newName- The new name of the source
virtual void IHyperlinkSource::SetOwningHyperlink (UID owningHyperlink)
pure virtual

Set the UID of the hyperlink that "owns" this source

Parameters
owningHyperlink- UID of the hyperlink