ILinksUIUtils.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 __ILinksUIUtils__
#define __ILinksUIUtils__

// ----- Includes -----
#include "IPMUnknown.h"
#include "LinksUIID.h"
#include "AppInfo.h"
#include "NodeID.h"

class ILink;
class ILinkResource;
class ILinkInfoProvider;
class IMetaDataAccess;
class IImageCache;

 namespace LinksUIUtils
 {
 const int kLinksUIColumnGap = 8;
 };
 
 
class ILinksUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKSUIUTILS };

 virtual void SelectLinksInPanel(const UIDList& inLinkUIDsToSelect) = 0;
 
 virtual UIDList GetLinksSelectedInPanel(bool16 inDisplayOrder = kFalse) = 0;
 
 virtual UIDList GetLinkResourcesSelectedInPanel(bool16 inDisplayOrder = kFalse) = 0;
 
 virtual UIDList GetLinksForMenuAction(IPMUnknown* widget, bool16 inDisplayOrder = kFalse) const = 0;

 virtual bool16 SomeCanEdit(UIDList &linkList) = 0;

 virtual bool16 SomeCanGoToSource(UIDList &linkList) = 0;

 virtual bool IsMenuActionEntirelyOnLinkResourceRows(IPMUnknown* widget) = 0;
 
 virtual void GetEditOriginalEditorList(AppInfoList& appList, UIDList &resources) = 0;

 virtual void EditOriginal(ILink *link, const AppInfo& appInfo = kNullAppInfo) = 0;

 virtual void GoToSource(ILink *link) const = 0;

 virtual UIDRef GetSingleLinkUIDRefSelectedInLayout() const = 0;

 virtual UIDList GetLinkUIDsOfSelectedItems() const = 0;

 virtual UIDList GetResourcesOfLinks(UIDList &links) const = 0;

 virtual void EditAllOriginals(UIDList &links, UIDList &resources, const AppInfo& appInfo = kNullAppInfo) const = 0;

 virtual void GoToAllSources(UIDList &links, UIDList &resources) const = 0;

 virtual void ToggleLinkInfoSectionVisibility(bool onlyShow, bool fitSizeToAvailableInfo) = 0;
 
 virtual void UpdateLinkInfoSectionButtonState() = 0;
 
 virtual void SetPanelSortProvider(const ILinkInfoProvider* newSortProvider) = 0;
 
 /* Unembed the passed in Links, by presenting the user with a browse to file dialog. returns true if it worked, false if not. false usually indicates user cancel. 
 @param targetLinks - links to unembed
 @param updateLink - if true, update the link
 @return true if it worked, false if not. false usually indicates user cancel.
 */
 virtual bool16 DoUnembedSelectedLinks(const UIDList& targetLinks, bool16 updateLink) const = 0;
 
 virtual const ILinkInfoProvider* QueryLinkInfoProviderFromHeaderWidget(const IPMUnknown* widget) = 0;

 virtual ILinkInfoProvider* QueryInfoProviderFromLinksUIWidget(const IPMUnknown* widget) const = 0;
 
 virtual ILink* QueryLinkFromLinksUIWidget(const IPMUnknown* widget) const = 0;
 
 virtual ILinkResource* QueryLinkResourceFromLinksUIWidget(const IPMUnknown* widget) const = 0;
 
 virtual NodeID_rv CreateNodeFromLinkUIDRef(UIDRef linkUIDRef) = 0;

 virtual IMetaDataAccess* QueryMetaDataAccessFromLink(const ILink* link) const = 0;

 virtual IImageCache* QueryThumbnailForLink(const ILink * theLink, const ILinkResource * linkResource) const = 0;

 virtual void SetupCaptionRowWidget(const IPMUnknown* newRowWidget,const PMString& beforeString, const PMString& providerName,const PMString& afterString) const = 0;
 

};

#endif