IHyperlinkSource.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 __IHyperlinkSource__
#define __IHyperlinkSource__

// Includes:
#include "HyperlinkID.h"

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

class IHyperlinkSource : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IHYPERLINKSOURCE };


 virtual void GoToHyperlinkSource() const = 0;

 // Get & Set the name of the hyperlink source

 virtual void GetName(PMString *pName) const = 0;
 
 // Get & Set the base name of this Hyperlink source

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


 virtual void SetHidden(bool16 bIsHidden) = 0;

 virtual bool16 IsHidden() const = 0;
 

 virtual void SetOwningHyperlink(UID owningHyperlink) = 0;

 virtual UID GetOwningHyperlink() const = 0;


 virtual void SetBookmarkUID(UID bookmarkUID) = 0;

 virtual UID GetBookmarkUID() const = 0;
};

#endif //__IHyperlinkSource__