InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
HTTPAssetLinkResourceHelperHandler.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Manohar Gour
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // ADOBE CONFIDENTIAL
16 //
17 // Copyright 2017 Adobe
18 // All Rights Reserved.
19 //
20 // NOTICE: Adobe permits you to use, modify, and distribute this file in
21 // accordance with the terms of the Adobe license agreement accompanying
22 // it. If you have received this file from a source other than Adobe,
23 // then your use, modification, or distribution of it requires the prior
24 // written permission of Adobe.
25 //
26 //========================================================================================
27 
28 #ifndef __HTTPAssetLinkResourceHelperHandler__
29 #define __HTTPAssetLinkResourceHelperHandler__
30 
31 #include "CPMUnknown.h"
32 
33 #include "ILink.h"
34 #include "ILinkResource.h"
35 #include "ILinkResourceHelperHandler.h"
36 
37 #include "LinksID.h"
38 
39 
40 // =============================================================================
41 // * HTTPAssetLinkResourceHelperHandler
42 // =============================================================================
43 
47 class HTTPAssetLinkResourceHelperHandler : public CPMUnknown<ILinkResourceHelperHandler>
48 {
49 public:
51 
54 
55  /*
56  @param ref [IN] UIDRef of the Link Resource.
57  @param uri [IN] uri of the Link Resource.
58  @param link [IN] link corresponding to the link resource.
59  @return Icon for the link in link panel.
60  */
61  virtual ILinkResourceHelper::IconStatus GetIcon(const UIDRef& ref, const URI& uri, const ILink* link) const;
62 
63  /*
64  @param ref [IN] UIDRef of the Link Resource.
65  @param uri [IN] uri of the Link Resource.
66  @param link [IN] link corresponding to the link resource.
67  @return Icon for the pageitem corresponding to the link.
68  */
69  virtual ILinkResourceHelper::IconStatus GetPageItemAdornmentIcon(const UIDRef& ref, const URI& uri, const ILink* link) const;
70 
71  /*
72  @return true if double click is allowed for inaccessible link else false.
73  */
74  virtual bool CanDoDoubleClickInaccessibleAction() const;
75 
76  // performs double click on inaccessible link.
77  virtual void DoubleClickInaccessibleAction() const;
78  /*
79 
80  @replace FPO with original asset.
81  */
82  virtual void ReplaceWithOriginalAsset() const;
83  /*
84 
85  @return true if URI specific inaccessible links action have to be taken.
86  */
87  virtual bool IsInaccessibleActionSupportedURIScheme() const;
88  /*
89 
90  @take URI specific inaccessible links.
91  */
92  virtual void InaccessibleActionOnOpenDoc() const;
93  /*
94  @param count [IN] no of links for which warning message have to be shown.
95  @return warning message for all same http type URI inaccessible links.
96  */
97  virtual PMString InaccessibleLinksWarningMessage(int32 count) const;
98 
106  virtual bool CanProvideSupportedApplicationList(const UIDRef& ref, const URI& uri) const;
107 
117  virtual void GetSupportedApplicationList(const UIDRef& ref, const URI& uri, AppInfoList& appList, bool16 bDefaultEditorOnly = false) const;
118 };
119 
120 #endif