InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IStringDataBase.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Michael Burbidge
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 __IStringDataBase_h__
25 #define __IStringDataBase_h__
26 
27 #include "IPMUnknown.h"
28 #include "PMLocaleId.h"
29 #include "WorkspaceID.h"
30 
31 class PMString;
32 class IStringDataBaseTable;
33 
34 //========================================================================================
35 // CLASS IStringDataBase
36 //========================================================================================
40 class IStringDataBase : public IPMUnknown
41 {
42 public:
43  enum { kDefaultIID = IID_ISTRINGDATABASE };
44 
51  virtual void Add(const PMLocaleId& localeId,
52  const PMString& key, const PMString& string, const PluginID &providingPlugin) = 0;
53 
59  virtual bool16 Retrieve(const PMLocaleId& localeId,
60  const PMString& key, PMString& string) const = 0;
61 
64  virtual void TurnOffMemoryPurge() = 0;
65 
70  virtual const IStringDataBaseTable* GetStringTable(const PMLocaleId& locale) const = 0;
71 
74  virtual void InitializationComplete(const PMLocaleId& locale) = 0;
75 
78  virtual void Cleanup() = 0;
79 
85  virtual bool16 Retrieve(const PMLocaleId& localeId,
86  ConstCString key, PMString& string) const = 0;
87 };
88 
89 #endif // __IStringDataBase_h__