InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CusDtLnkLinkResourceHandler.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Adobe Developer Technologies
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //
23 // Description:
24 //
25 //========================================================================================
26 
27 #ifndef __CusDtLnkLinkResourceHandler__
28 #define __CusDtLnkLinkResourceHandler__
29 
30 // ----- Includes -----
31 #include "CPMUnknown.h"
32 #include "ILinkResourceHandler.h"
33 
34 
45 class CusDtLnkLinkResourceHandler : public CPMUnknown<ILinkResourceHandler>
46 {
47 public:
49  typedef object_type data_type;
50 
52  virtual ~CusDtLnkLinkResourceHandler();
53 
56  virtual bool Init(const UIDRef& ref, const URI& uri) { return true; }
57 
60  virtual bool IsResourceURIValid(const UIDRef& ref, const URI& uri) const;
63  virtual bool AreResourceIdsEquivalent(const ILinkResource::ResourceId& id1, const ILinkResource::ResourceId& id2) const;
66  virtual FileTypeInfo GetResourceDataType(const UIDRef& ref, const URI& uri) const;
67 
70  virtual WideString GetShortResourceName(const UIDRef& ref, const URI& uri, bool bUIName) const;
73  virtual WideString GetLongResourceName(const UIDRef& ref, const URI& uri, bool bUIName) const;
74 
77  virtual PMString GetResourceStateInfo(const UIDRef& ref, const URI& uri, ILinkResource::ResourceState state, ILinkResource::ResourceStoreState storeState) const { return PMString(); }
78 
81  virtual bool AreStampsEquivalent(const WideString& stamp1, const WideString& stamp2) const;
82 
85  virtual bool CanReadResource(const UIDRef& ref, const URI& uri) const;
88  virtual bool CanWriteResource(const UIDRef& ref, const URI& uri) const;
91  virtual bool CanReadWriteResource(const UIDRef& ref, const URI& uri) const;
92 
95  virtual bool CanCreateResourceStream(const UIDRef& ref, const URI& uri, ILinkResource::AccessMode mode) const;
98  virtual IPMStream* CreateResourceReadStream(const UIDRef& ref, const URI& uri) const;
101  virtual IPMStream* CreateResourceWriteStream(const UIDRef& ref, const URI& uri) const;
104  virtual IPMStream* CreateResourceReadWriteStream(const UIDRef& ref, const URI& uri) const;
105 
108  virtual bool CanCacheResource(const UIDRef& ref, const URI& uri) const { return true; }
111  virtual bool CanEmbedResource(const UIDRef& ref, const URI& uri) const { return true; }
114  virtual bool CanUnembedResource(const UIDRef& ref, const URI& uri) const { return true; }
115 
119  virtual bool CanCopyToFile(const UIDRef& ref, const URI& uri) const;
120 
123  virtual ErrorCode CopyToFile(const UIDRef& ref, const URI& uri, IDFile& file) const;
124 
127  virtual bool CanEditResource(const UIDRef& ref, const URI& uri) const;
130  virtual ErrorCode EditResource(const UIDRef& ref, const URI& uri, const AppInfo& appInfo, PMString* errorString) const;
131 
134  virtual bool CanRevealResource(const UIDRef& ref, const URI& uri) const;
137  virtual ErrorCode RevealResource(const UIDRef& ref, const URI& uri) const;
140  virtual bool CanRevealResourceInBridge(const UIDRef& ref, const URI& uri) const;
143  virtual ErrorCode RevealResourceInBridge(const UIDRef& ref, const URI& uri) const;
146  virtual bool CanRevealResourceInCloudLibraries(const UIDRef& ref, const URI& uri) const { return false; }
149  virtual ErrorCode RevealResourceInCloudLibraries(const UIDRef& ref, const URI& uri) const { return kFailure; }
152  virtual bool GetXMPPacketInfo(const UIDRef& resourceRef, const URI& uri, std::string& packet) const { return false; }
155  virtual bool CanGetXMPPacketInfo(const UIDRef& ref, const URI& uri) const { return false; }
158  virtual bool CanDownloadOriginalResource(const UIDRef& ref, const URI& uri) const { return false; }
161  virtual ErrorCode DownloadOriginalResource(const UIDRef& ref, const URI& uri) const { return kFailure; }
164  virtual ErrorCode AsyncDownloadOriginalResource(const UIDRef& ref, const URI& uri, ILinkResource::DownloadCompletionFunction completionFunction) const { return kFailure; }
167  virtual bool CanReplaceFPOWithOriginalResource(const UIDRef& ref, const URI& uri) const { return false; }
173  virtual bool CanProvideFile(const UIDRef& ref, const URI& uri) const { return false; }
176  virtual ErrorCode GetFile(const UIDRef& ref, const URI& uri, IDFile& idFile) const { return kFailure; }
177  virtual bool canGetInstanceName() const { return false; }
178  virtual ErrorCode GetInstanceName(PMString &uri) const { return kFailure; }
179 
180 private:
181  // Prevent copy construction and assignment.
184 };
185 
186 #endif // __CusDtLnkLinkResourceHandler__