IHyperlinkSuite.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 __IHyperlinkSuite__
#define __IHyperlinkSuite__

// Interfaces:
#include "IPMUnknown.h"
#include "HyperlinkID.h"

class UIDList;

// Includes:
class IHyperlinkSuite : public IPMUnknown
{
public:
 virtual bool16 CanCreateHyperlinkSource() const = 0;

 virtual bool16 CanCreateXRefSource() const = 0;

 virtual bool16 CanCreateHyperlinkDestination() const = 0;

 virtual bool16 CanChangeHyperlinkSource(UIDRef source) const = 0;

 virtual bool16 CanChangeHyperlinkDestination(UIDRef dest) const = 0;

 virtual bool16 CanCreateBookmark() const = 0;
 

 virtual UID GetHyperlinkSource() const = 0;
 
 virtual UID CreateHyperlinkSource(const PMString *name, UID charStyle = kInvalidUID) const = 0;

 virtual UID CreateXRefSource(const PMString *name, UID format = kInvalidUID) const = 0;

 virtual UID CreateHyperlinkDestination(const PMString *sourceName) const = 0;

 virtual UID CreateBookmark(int32 indentLevel, UID parentBookmark) const = 0;
 
 virtual UID ChangeHyperlinkSource(UIDRef source, const PMString *name) const = 0;

 virtual UID ChangeHyperlinkDestination(UIDRef dest, const PMString *sourceName) const = 0;

 virtual void GenerateHyperlinkSourceName(PMString *sourceName, bool16 bUnique = kTrue) const = 0;

 virtual void GenerateHyperlinkDestinationName(PMString *destName, bool16 bUnique = kTrue, int32 maxLength = 100) const = 0;

 virtual UIDList GetSelectedHyperlinkSources() const = 0;
};

#endif // __IHyperlinkSuite__