IHyperlinkCmdData.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 __IHyperlinkCmdData__
#define __IHyperlinkCmdData__

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

class IHyperlinkCmdData : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IHYPERLINKCMDDATA};
 
 // General hyperlink characteristics (required):

 virtual void Set( const UIDRef &hyperLinkDestination,
 const PMString *name = nil) = 0;


 virtual void InitializeToDefaultAppearance(IDataBase *db) = 0;


 virtual void SetHyperlinkName(const PMString *name = nil) = 0;

 virtual const PMString& GetHyperlinkName() const = 0;

 virtual bool16 ChangingHyperlinkName() const = 0;


 virtual void SetHyperlinkDestination(const UIDRef &hyperLinkDestination) = 0;

 virtual const UIDRef &GetHyperlinkDestination() const = 0;

 virtual void SetHyperlinkDestinationUniqueKey(int32 uniqueKey) = 0;
 virtual int32 GetHyperlinkDestinationUniqueKey() const = 0;

 virtual bool16 ChangingHyperlinkDestination() const = 0;

 // Hyperlink Appearance characteristics (optional):

 virtual void SetVisible(const bool16 bIsVisible) = 0;

 virtual bool16 GetVisible() const = 0;

 virtual bool16 ChangingVisibleAttribute() const = 0;


 virtual void SetBorderLineWidth(const int32 strokeWidthInPixels) = 0;

 virtual int32 GetBorderLineWidth() const = 0;

 virtual bool16 ChangingBorderLineWidth() const = 0;


 virtual void SetHyperlinkHilight(IHyperlinkAppearanceData::HyperlinkHilight hilightType) = 0;

 virtual IHyperlinkAppearanceData::HyperlinkHilight GetHyperlinkHilight() const = 0;

 virtual bool16 ChangingHyperlinkHilight() const = 0;
 

 virtual void SetBorderColorUID(const UID interfaceColorUID) = 0;

 virtual const UID GetBorderColorUID() const = 0;

 virtual bool16 ChangingBorderColor() const = 0;


 virtual void SetHyperlinkOutlineLineStyle(IHyperlinkAppearanceData::HyperlinkOutlineLineStyle style) = 0;

 virtual IHyperlinkAppearanceData::HyperlinkOutlineLineStyle GetHyperlinkOutlineLineStyle() const = 0;

 virtual bool16 ChangingHyperlinkOutlineLineStyle() const = 0;

 virtual void SetFileMissing(bool16 fileMissing) = 0;
 virtual bool16 GetFileMissing() const = 0;
 virtual bool16 ChangingFileMissing() const = 0;
 
 virtual bool16 IsFromDuplicate() const = 0;
 virtual void SetFromDuplicate(bool16 fromDup) = 0;

 virtual bool16 ChangingHyperlinkAltText() const = 0;

 virtual void SetHyperlinkAltText(const PMString altText) = 0;

 virtual const PMString GetHyperlinkAltText() = 0;

};


#endif // __IHyperlinkCmdData__