IHyperlink.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.
// 
// 
// IHyperlink is the abstract interface to a hyperlink
// 
//========================================================================================

#ifndef __IHyperlink__
#define __IHyperlink__

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

class PMString;

class IHyperlink : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IHYPERLINK };

 virtual void GetName(PMString *pName) const = 0;
 
 virtual void SetName(const PMString& newName) = 0;

 virtual void GetDisplayName(PMString *pName) const = 0;

 virtual void SetDisplayName(const PMString& newName) = 0;
 
 virtual const UID& GetSourceUID() const = 0;

 virtual UID GetDestinationUID() const = 0;
 
 virtual uint32 GetDestinationUniqueKey() const = 0;

 virtual void SetSourceUID(const UID newSourceUID) = 0;

 virtual void SetDestinationUniqueKey(uint32 newDestKey) = 0;

 virtual void SetHidden(bool16 bIsHidden) = 0; 

 virtual bool16 IsHidden() const = 0; 

 virtual void SetExternalDestination(bool16 bIsDestinationExternal) = 0; 

 virtual bool16 IsExternalDestination() const = 0; 

 virtual bool16 IsDestInExternalFile() const = 0; 

 virtual void GoToSource() const = 0;

 virtual void GoToDestination() const = 0;

 // For getting and setting the destination Icons

 virtual void GetIcon(RsrcID *iconID, PluginID *pluginID) const = 0;

 virtual void SetIcon(RsrcID iconID, PluginID pluginID) = 0;

 virtual bool16 IsUnresolvedLink() const = 0;
 virtual bool16 destInHiddenLayer() const = 0;
 virtual bool16 IsOutOfDateLink() const = 0;

 virtual UIDRef GetDestinationUIDRef() const = 0;
};

#endif