ILinkResourceHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Manohar Gour
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2016 Adobe 
// 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.
// 
// Description:
// This class defines an interface used to maintain and access UI properties of a linked resource.
// 
//========================================================================================

#ifndef __ILinkResourceHelper__
#define __ILinkResourceHelper__

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


class FileTypeInfo;
class IDTime;
class PMString;
class UIDList;
class URI;
class WideString;
class ILink;

class ILinkResourceHelper : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILINKRESOURCEHELPER };
 /*caution: Please don't change values of this enum as it is use to sort icons in shared content ui.
 this value will be decisive in case of multiple page items in a group */
 enum IconState {
 kIconUnknown = 0,
 kIconEmbedded = 5,
 kIconOk = 10,
 kIconMissing = 15,
 kIconInaccessible = 20,
 kIconModified = 25
 };

 struct IconStatus {

 IconStatus(PMRsrcID icon, IconState state, int32 priority,PMString msg=PMString("")) :
 fIcon(icon), fState(state), fPriority(priority),fmsg(msg) {}

 PMRsrcID fIcon;
 IconState fState;
 int32 fPriority;
 PMString fmsg;
 };

 virtual IconStatus GetIcon(const ILink* link) const = 0;
 virtual IconStatus GetPageItemAdornmentIcon(const ILink* link) const = 0;

 virtual bool CanDoDoubleClickInaccessibleAction() const = 0;
 virtual void DoubleClickInaccessibleAction() const = 0;
 virtual void ReplaceWithOriginalAsset() const = 0;
 virtual bool IsInaccessibleActionSupportedURIScheme() const = 0;
 virtual void InaccessibleActionOnOpenDoc() const = 0;
 virtual PMString InaccessibleLinksWarningMessage(int32 count) const = 0;


 virtual bool CanProvideSupportedApplicationList() const = 0;

 virtual void GetSupportedApplicationList(AppInfoList& appList, bool16 bDefaultEditorOnly = false) const = 0;
};


//Some well known Adobe icon priorities 
const int32 kDefaultLinkIconPriority = 10;
const int32 kFileLinkIconPriority = kDefaultLinkIconPriority + 10;
const int32 kCCLibLinkIconPriority = kFileLinkIconPriority + 10;
const int32 kHTTPLinkIconPriority = kCCLibLinkIconPriority + 10;
const int32 kHTTPFPOLinkIconPriority = kHTTPLinkIconPriority + 10;
const int32 kAALLinkIconPriority = kHTTPFPOLinkIconPriority + 10;
const int32 kAALFPOLinkIconPriority = kAALLinkIconPriority + 10;
const int32 kCCACLibLinkIconPriority = kAALFPOLinkIconPriority + 10;



#endif // __ILinkResource__