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

#include <IHyperlinkTextDestinationMarker.h>

Inheritance diagram for IHyperlinkTextDestinationMarker:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPERLINKTEXTDESTINATIONMARKER }
 

Public Member Functions

virtual void Initialize (const IHyperlinkTextDestinationData *textHyperlinkDestinationData, const ITextModel *textModel)=0
 
virtual UID GetHyperlinkDestinationUID () const =0
 
virtual UID GetTextModel () const =0
 
virtual TextIndex UpdateLocation (TextIndex newTextIndex=-1)=0
 
virtual TextIndex GetLocation () 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

Interface for hyperlink text destination marker object. This is the interface for kHyperlinkTextDestinationMarkerBoss to represent the text marker for hyperlink text destination.

Member Function Documentation

virtual UID IHyperlinkTextDestinationMarker::GetHyperlinkDestinationUID () const
pure virtual

Get the hyperlink destination UID (Will return kInvalidUID if GetHyperlinkSourceUID() returns a valid UID)

Parameters
none
Returns
UID - UID of the destination
virtual TextIndex IHyperlinkTextDestinationMarker::GetLocation () const
pure virtual

Get the location of this marker as a TextIndex

Parameters
none
Returns
TextIndex - This marker's location in the text strand
virtual UID IHyperlinkTextDestinationMarker::GetTextModel () const
pure virtual

Get the UID of the text model that this marker points to

Parameters
none
Returns
UID - UID of the text model
virtual void IHyperlinkTextDestinationMarker::Initialize (const IHyperlinkTextDestinationData * textHyperlinkDestinationData,
const ITextModel * textModel 
)
pure virtual

Initilize this class using all of the information at once rather than having to call several methods one after the other

Parameters
textHyperlinkDestinationData- The destination that this marker is related to
*textModel- Text model to point to
virtual TextIndex IHyperlinkTextDestinationMarker::UpdateLocation (TextIndex newTextIndex = -1)
pure virtual

Update this markers location

Parameters
newTextIndex- Setting this to a value other than -1 will set the new location to that value
Returns
TextIndex - This marker's location in the text strand