ILinkInfoProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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 __ILinkInfoProvider__
#define __ILinkInfoProvider__

#include "IPMUnknown.h"
#include "LinksID.h"

class ILink;
class ILinkResource;
class IObserver;
class IDocument;

class ILinkInfoProvider : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKINFOPROVIDER };

 virtual PMString GetInfoDescriptionString() const = 0;
 
 virtual PMRsrcID GetInfoDescriptionIcon() const = 0;
 
 virtual PMString GetUpdatedInfoForLink(const ILink* link, const ILinkResource* linkResource, bool shortForm) const = 0;
 
 virtual PMRsrcID GetUpdatedIconForLink(const ILink* link, const ILinkResource* linkResource) const = 0;

 virtual bool16 IsLinkInfoDynamic() const = 0;
 
 virtual bool16 CanDoSingleClickAction(const ILink* link, const ILinkResource* linkResource) const = 0;
 
 virtual void DoSingleClickAction(const ILink* link, const ILinkResource* linkResource) = 0;

 virtual bool16 CanDoDoubleClickAction(const ILink* link, const ILinkResource* linkResource) const = 0;
 
 virtual void DoDoubleClickAction(const ILink* link, const ILinkResource* linkResource) = 0;
 
 virtual PMString GetDoubleClickDescription(const ILink* link, const ILinkResource* linkResource) const = 0;

 virtual int32 GetDefaultColumnWidth() const = 0;
 
 virtual int16 GetInfoTextAlignment() const = 0;

 virtual void AttachToDocument(IObserver *observer, const IDocument* newDoc) = 0;

 virtual void DetachFromDocument(IObserver *observer, const IDocument* oldDoc) = 0;

 virtual bool16 ShouldCauseRefreshOfInfo(const PMIID &protocol) const = 0;
 
 virtual int32 Compare(const ILink* link1, const ILinkResource* linkResource1,const ILink* link2, const ILinkResource* linkResource2) const = 0;


};

#endif