InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILibrary.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Mark VerMurlen
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 // Reviewed: 9/25/98
24 //
25 // Purpose:
26 // This interface is the main interface to the Library Boss. This interface
27 // controls openning and closing of the Library file and has various utility
28 // methods to determine the status of the Library file.
29 //
30 //========================================================================================
31 
32 #ifndef __ILibrary__
33 #define __ILibrary__
34 
35 #include "IPMUnknown.h"
36 #include "LibraryProviderID.h"
37 
38 
39 class ILibraryScrapController;
40 
44 class ILibrary : public IPMUnknown
45 {
46 public:
47  enum { kDefaultIID = IID_ILIBRARY };
48 
52  virtual ErrorCode Initialize() = 0;
53 
59  virtual bool16 Open( const IDFile &libraryFile, const PMString & actualFileName ) = 0;
60 
66  virtual bool16 Create( const IDFile &libraryFile, const PMString & actualFileName ) = 0;
67 
70  virtual void Close() = 0;
71 
75  virtual bool16 IsOpen() const = 0;
76 
80  virtual bool16 IsLocked() const = 0;
81 
85  virtual int32 Length() const = 0;
86 
90  virtual IDFile GetLibraryFileSpec() const = 0;
91 
95  virtual PMString GetFileName() const = 0;
96 
97 
98  //-------------- For Internal Use Only -------------------------
99 
100  // Tell whether the library is old and needs to be converted to snippet data store
101  // Note: This will return kFalse if snippets are turned off in the QA menu.
102  // Plus: Do not call this on an already-open library -- use LibraryIsPreSnippets()
105  virtual bool16 NeedsSnippetConversion( const IDFile &libraryFile ) = 0;
106 
107  // Converts the input library file to snippet data storage format
110  virtual bool16 ConvertToSnippets( const IDFile &oldLibraryFile, IDFile &newLibraryFile, bool16 bUseOldName = kFalse ) = 0;
111 
112  // Tell whether the file is pre-snippets. Assumes the file is open already
115  virtual bool16 LibraryIsPreSnippets() = 0;
116 
117  // Gets the interface to the library scrap controller
120  virtual ILibraryScrapController* GetScrapController() const = 0;
121 
122  // Disable and Enable Notification of Library Open and Close events
125  virtual void DisableLibraryLevelNotification() = 0;
128  virtual void EnableLibraryLevelNotification() = 0;
129 };
130 
131 #endif