IHyperlinkMarker.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IHyperlinkMarker__
#define __IHyperlinkMarker__

#include "IPMUnknown.h"
#include "HyperlinkID.h"

class IHyperlinkTextSourceData;
class IHyperlinkTextDestinationData;
class ITextModel;

class IHyperlinkMarker : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHYPERLINKTEXTMARKER };


 // return the UID of the hyperlink source or destination that "owns" this text marker.
 // Caveat: One of the following two *will* return kInvalidUID

 virtual UID GetHyperlinkSourceUID() const = 0;

 virtual UID GetHyperlinkDestinationUID() const = 0;


 virtual UID GetTextModel( ) const = 0;

 virtual TextIndex GetLocation() const = 0;

 virtual UID GetOtherMarkerUID() const = 0;
};


#endif // __IHyperlinkMarker__