IHyperlinkTable.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 __IHyperlinkTable__
#define __IHyperlinkTable__

#include "IPMUnknown.h"
#include "HyperlinkID.h"
#include <map>

class UIDList;

typedef std::map< int32, UID> UniqueKeyToUIDMap;

class IHyperlinkTable : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHYPERLINKTABLE };

 typedef enum {
 kHyperlinks,
 kSources,
 kDestinations,
 kBookmarks,
 kXRefFormats,
 kAll} WhichCache;

 virtual void InvalidateNameCache(IHyperlinkTable::WhichCache whichCache) = 0;

 virtual bool16 HasExternalDestination() const = 0;

 virtual void SetHasExternalDestination(bool16 fHasExternDest) = 0;
 
 //----------------------------------------------------------------------------------------------//
 // Sources:
 //----------------------------------------------------------------------------------------------//

 virtual void AddHyperlinkSource(const UID hyperlinkSource) = 0; 

 virtual void RemoveHyperlinkSource(const UID hyperlinkSource) = 0;

 virtual int32 GetHyperlinkSourceCount() const = 0;

 virtual UID GetNthHyperlinkSource(int32 hyperlinkIndex) const = 0;

 virtual int32 GetHyperlinkSourceIndex(const UID hyperlinkSourceUID) const = 0;

 virtual void GenerateNewHyperlinkSourceName(PMString* pName) = 0;

 //----------------------------------------------------------------------------------------------//
 // Destinations (a.k.a. target; a.k.a. anchor):
 //----------------------------------------------------------------------------------------------//

 virtual void AddHyperlinkDestination(const UID hyperlinkDestination) = 0;

 virtual void RemoveHyperlinkDestination(int32 hyperlinkDestinationKey) = 0;

 virtual void SwapHyperlinkDestinations(int32 destKey1, int32 destKey2) = 0;
 
 virtual int32 GetHyperlinkDestinationCount() const = 0;

 virtual bool16 IsValidHyperlinkDestinationKey(int32 hyperlinkDestinationKey) const = 0;

 virtual UID GetHyperlinkDestinationWithKey(int32 hyperlinkKey) const = 0;
 
 virtual void GenerateNewHyperlinkDestinationName(PMString* pName) = 0;

 virtual UniqueKeyToUIDMap::const_iterator GetDestinationKeyToUIDMapBeginIter() const = 0;

 virtual UniqueKeyToUIDMap::const_iterator GetDestinationKeyToUIDMapEndIter() const = 0;
 
 virtual UniqueKeyToUIDMap::const_reverse_iterator GetDestinationKeyToUIDMapRBeginIter() const = 0;
 
 virtual UniqueKeyToUIDMap::const_reverse_iterator GetDestinationKeyToUIDMapREndIter() const = 0;
 
 //----------------------------------------------------------------------------------------------//
 // Hyperlinks:
 //----------------------------------------------------------------------------------------------//

 virtual void AddHyperlink(const UID hyperlink) = 0;

 virtual UID RemoveHyperlink(const UID hyperlinkUID) = 0;

 virtual void MoveHyperlink(const UID hyperlink, const UID moveBefore) = 0;

 virtual UID GetNthHyperlink(int32 hyperlinkIndex) const = 0;

 virtual int32 GetHyperlinkWithUID(const UID hyperlink) const = 0;

 virtual int32 GetHyperlinkCount() const = 0;

 virtual void GenerateNewHyperlinkName(PMString* pName) = 0;

 virtual UID GetHyperlinkOfSource(UIDRef sourceUIDRef) const = 0;

 //----------------------------------------------------------------------------------------------//
 // Bookmarks:
 //----------------------------------------------------------------------------------------------//

 virtual void AddBookmark(const UID bookmark) = 0;

 virtual void RemoveBookmark(const UID bookmarkUID) = 0;

 virtual void MoveBookmark(const UID bookmark, int32 newLoc) = 0;

 virtual UID GetNthBookmark(int32 bookmarkIndex) const = 0;

 virtual int32 GetBookmarkWithUID(const UID bookmark) const = 0;

 virtual int32 GetBookmarkCount() const = 0;

 virtual void GenerateNewHyperlinkBookmarkName(PMString* pName) = 0;

 //----------------------------------------------------------------------------------------------//
 // XRef formats:
 //----------------------------------------------------------------------------------------------//

 virtual void AddXRefFormat(const UID xRefFormat) = 0;
 
 virtual bool16 RemoveXRefFormat(const UID xRefFormat) = 0;

 virtual int32 GetXRefFormatCount() const = 0;

 virtual UID GetNthXRefFormat(int32 formatIndex) const = 0;
 
 virtual int32 GetXRefFormatIndex(const UID xRefFormatUID) const = 0;

 virtual bool16 HasXRefFormatName(const PMString& name) = 0;

 virtual UID GetXRefFormatOfName(const PMString& name) = 0;

 virtual void GenerateNewXRefFormatName(PMString* pName) = 0;
};


#endif // __IHyperlinkTable__