InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDictionaryUtils.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Bernd Paradies
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 __IDictionaryUtils__
25 #define __IDictionaryUtils__
26 
27 #include "IPMUnknown.h"
28 
29 #include "LinguisticID.h"
30 #include "K2Vector.h"
31 #include "KeyValuePair.h"
32 
33 class IDocument;
34 class WideString;
35 class PMString;
36 class ILanguage;
38 class IScript;
39 class IUserDict;
40 class IScriptRequestData;
41 
43 
44 
45 #include "ITextUtils.h" //for FuncIsWordChar
46 
54 {
55 public:
56  enum { kDefaultIID = IID_IDICTIONARYUTILS };
57 
58  virtual bool16 GetAllUserDictsStringList(HyphenExceptionsList& list, bool16 bMerge) const = 0;
59  virtual void CopyUserDictsToDocument(IDocument * doc) const = 0;
60  virtual bool16 CheckForAndHandleHyphConflicts(IDocument * doc, HyphenExceptionsList& heList) const = 0;
61  virtual bool16 GetProximityWord( const PMString& rNewWord, WideString *pWord, HyphenPoints *pPoints ) const = 0;
62 
78  virtual bool16 ImportUserDict( ILanguage* pLang, IUserDict* userDict, ClassID nProvider, IDFile *userDoctFile = nil, bool16 replaceOldDict = kTrue, bool16 ignoreRanking = kFalse, FuncIsWordChar isDictWordChar = nil, bool16 caseSensitive = kFalse ) const = 0;
79 
90  virtual bool16 ExportUserDict( ILanguage* pLang, IUserDict* userDict, ClassID nProvider, IDFile *userDoctFile = nil ) const = 0;
91 
92  //For Scripting
93  virtual int32 GetNumUserDicts() const = 0 ;
94  virtual IScript* QueryUserDictByName( const IScriptRequestData* data, const PMString& name ) const = 0 ;
95  virtual IScript* QueryUserDictByLanguageIndex( const IScriptRequestData* data, int32 n ) const = 0 ;
96  virtual IScript* QueryUserDictByIndex( const IScriptRequestData* data, int32 n ) const = 0 ;
97 };
98 
99 
100 #endif // __IDictionaryUtils__