InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILinkResourceHelperHandler Class Referenceabstract

#include <ILinkResourceHelperHandler.h>

Inheritance diagram for ILinkResourceHelperHandler:
IPMUnknownCPMUnknown< ILinkResourceHelperHandler >CusDtLnkLinkResourceHelperHandlerHTTPAssetLinkResourceHelperHandlerCusHttpLnkLinkResourceHelperHandler

Public Types

enum  { kDefaultIID = IID_ILINKRESOURCEHELPERHANDLER }
 

Public Member Functions

virtual
ILinkResourceHelper::IconStatus 
GetIcon (const UIDRef &ref, const URI &uri, const ILink *link) const =0
 
virtual
ILinkResourceHelper::IconStatus 
GetPageItemAdornmentIcon (const UIDRef &ref, const URI &uri, 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 UIDRef &ref, const URI &uri) const =0
 
virtual void GetSupportedApplicationList (const UIDRef &ref, const URI &uri, AppInfoList &appList, bool16 bDefaultEditorOnly=false) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (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 ILinkResourceHelperHandler::CanProvideSupportedApplicationList (const UIDRefref,
const URIuri 
) 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. Remeber to override function GetSupportedApplicationList too if returning true here.

Parameters
ref[IN] UID reference of the link resource.
uri[IN] URI of the link resource.
Returns
true if the resource can provide the list. List will be extracted using function GetSupportedApplicationList() in case this function returns true.

Implemented in HTTPAssetLinkResourceHelperHandler, and CusDtLnkLinkResourceHelperHandler.

virtual void ILinkResourceHelperHandler::GetSupportedApplicationList (const UIDRefref,
const URIuri,
AppInfoListappList,
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
ref[IN] UID reference of the link resource.
uri[IN] URI of the link resource.
bDefaultEditorOnly[IN] if to fill the list with only default editor
appList[OUT] list which will be filled with supported applications

Implemented in HTTPAssetLinkResourceHelperHandler, and CusDtLnkLinkResourceHelperHandler.