ILinkResourceHelper Class Reference

#include <ILinkResourceHelper.h>

Inheritance diagram for ILinkResourceHelper:

Classes
struct	IconStatus

Public Types
enum	{ kDefaultIID = IID_ILINKRESOURCEHELPER }
enum	IconState {   kIconUnknown = 0, kIconEmbedded = 5, kIconOk = 10, kIconMissing = 15,   kIconInaccessible = 20, kIconModified = 25 }

Public Member Functions
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Experimental interface - will be modified/documented in future.

Member Function Documentation

virtual bool ILinkResourceHelper::CanProvideSupportedApplicationList ( ) const

pure virtual

Determines if a resource can provide the list of supported applications which can be used to open resource. This list is shown in the context menu of this resource.

Returns

true if the resource can provide the list. List will be extracted using function GetSupportedApplicationList() in case this function returns true.

virtual IconStatus ILinkResourceHelper::GetIcon ( const ILink *  link ) const

pure virtual

Returns the icon, it's state & it's priority withing the state.

Parameters

link	[IN] The link corresponding to the resource

Returns

icon and it's status.

virtual void ILinkResourceHelper::GetSupportedApplicationList ( AppInfoList &  appList, bool16  bDefaultEditorOnly = false  ) const

pure virtual

Get the list of applications supported by resource. This list is shown in the context menu of this link. This function is called only if CanProvideSupportedApplicationList return true. This function will genreally be used when user want to customize/add/delete to the list of softwares which can be used to edit this resource.

Parameters

bDefaultEditorOnly	[IN] if to fill the list with only default editor
appList	[OUT] list which will be filled with supported applications