IHyperlinkAppearanceData.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 __IHyperlinkAppearanceData__
#define __IHyperlinkAppearanceData__

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

class IHyperlinkAppearanceData : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IHYPERLINKAPPEARANCEDATA };

 virtual void SetVisible(const bool16 bIsVisible) = 0;

 virtual bool16 GetVisible() const = 0;


 virtual void SetBorderLineWidth(const int32 strokeWidthInPixels) = 0;

 virtual int32 GetBorderLineWidth() const = 0;

 typedef enum { kNoHyperlinkHilight = 0, 
 kInvertHyperlinkHilight = 1, 
 kInsetHyperlinkHilight = 2, 
 kOutlineHyperlinkHilight = 3} HyperlinkHilight;


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

 virtual HyperlinkHilight GetHyperlinkHilight() const = 0;


 virtual void SetBorderColorUID(const UID interfaceColorUID) = 0;

 virtual const UID GetBorderColorUID() const = 0;

 typedef enum { kHyperlinkSolidOutline = 0,
 kHyperlinkDashedOutline = 1 } HyperlinkOutlineLineStyle;


 virtual void SetHyperlinkOutlineLineStyle(HyperlinkOutlineLineStyle style) = 0;

 virtual HyperlinkOutlineLineStyle GetHyperlinkOutlineLineStyle() const = 0;
};

#endif