InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IStoryUtils.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner:
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 
24 #ifndef __IStoryUtils__
25 #define __IStoryUtils__
26 
27 #include "InCopySharedID.h"
28 #include "Utils.h"
29 
30 class IDocument;
31 class ILink;
32 class URI;
40 class IStoryUtils : public IPMUnknown
41 {
42 public:
43  enum { kDefaultIID = IID_ISTORYUTILS };
44 
51  virtual bool16 HasStories(const IDocument *fromDoc) const = 0;
52 
58  virtual UIDList GetStories(const IDocument *fromDoc) const = 0;
59 
65  virtual UIDList GetStoryLinks(const IDocument *fromDoc) const = 0;
66 
73  virtual bool16 IsAStory(const UIDRef& itemRef) const = 0;
74 
81  virtual bool16 IsAStoryFormatName(const PMString & formatName) const = 0;
82 
88  virtual bool16 IsAStoryInterchangeFileTypeID(const FileTypeInfoID& fileTypeID) const = 0;
89 
95  virtual bool16 IsAStoryDocumentFileTypeID(const FileTypeInfoID& fileTypeID) const = 0;
96 
102  virtual bool16 IsCurrentStoryDocumentFileType(const FileTypeInfoID& fileTypeID) const = 0;
103 
109  virtual bool16 IsAnyCurrentStoryFileType(const FileTypeInfoID& fileTypeID) const = 0;
110 
116  virtual bool16 IsAnyStoryFileTypeID(const FileTypeInfoID& fileTypeID) const = 0;
117 
123  virtual bool16 IsLinkResourceOutOfDate(const UIDRef& itemRef) const = 0;
124 
134  virtual ErrorCode CreateLink(const UIDRef& story, const IDFile& file, ClassID provider, FileTypeInfoID fileTypeInfo, UID& linkUID) = 0;
135 
142  virtual bool16 IsLinkResourceAccessible(const UIDRef& storyRef) const = 0;
143 
149  virtual bool16 IsAStoryLink( const ILink * iLink ) const = 0;
150 
156  virtual PMString GetStoryFormatType(const UIDRef& itemRef) const = 0;
157 
164  virtual bool16 IsCloudStory( const UIDRef& itemRef ) const = 0;
165 
166 };
167 
168 #endif // __IStoryUtils__