IHyperlinkDestination.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 __IHyperlinkDestination__
#define __IHyperlinkDestination__

// Includes:
#include "HyperlinkID.h"

// Classes:
class ISpread;
class IDocument;
class IHierarchy;
class IPMStream;

class IHyperlinkDestination : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHYPERLINKDESTINATION };

 enum DestType
 {
 kTextAnchorDestination = 0,
 kPageDestination,
 kURLDestination,
 kExternalPageDestination,
 };

 virtual void GoToHyperlinkDestination() const = 0;


 virtual void SetHidden(bool16 bIsHidden) = 0; 

 virtual bool16 IsHidden() const = 0; 


 virtual void GetName(PMString *destName) const = 0;

 virtual void SetName(const PMString &destName) = 0;

 virtual uint32 GetKey() const = 0;

 virtual void SetKey(uint32 destKey) = 0;
 
 // The following methods are included for extensibility
 // They are intended as ways for current dialogs to be able
 // to give users basic information about destination types that
 // may be added in the future.

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

 // Get this destination's type as a string ("Page", "Text Anchor", "URL")

 virtual void GetType(PMString *destType) const = 0;

 // Get this destination's type as a DestType enum

 virtual DestType GetType() const = 0;

 // Get information about this destination (Page it is on, URL it points to, etc)

 virtual void GetInfo(PMString *destInfo) const = 0;
};

#endif // __IHyperlinkDestination__