Line data Source code
1 : /*
2 : * DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/mozISpellCheckingEngine.idl
3 : */
4 :
5 : #ifndef __gen_mozISpellCheckingEngine_h__
6 : #define __gen_mozISpellCheckingEngine_h__
7 :
8 :
9 : #ifndef __gen_nsISupports_h__
10 : #include "nsISupports.h"
11 : #endif
12 :
13 : /* For IDL files that don't want to include root IDL files. */
14 : #ifndef NS_NO_VTABLE
15 : #define NS_NO_VTABLE
16 : #endif
17 : class nsIFile; /* forward declaration */
18 :
19 : class mozIPersonalDictionary; /* forward declaration */
20 :
21 :
22 : /* starting interface: mozISpellCheckingEngine */
23 : #define MOZISPELLCHECKINGENGINE_IID_STR "8ba643a4-7ddc-4662-b976-7ec123843f10"
24 :
25 : #define MOZISPELLCHECKINGENGINE_IID \
26 : {0x8ba643a4, 0x7ddc, 0x4662, \
27 : { 0xb9, 0x76, 0x7e, 0xc1, 0x23, 0x84, 0x3f, 0x10 }}
28 :
29 1 : class NS_NO_VTABLE mozISpellCheckingEngine : public nsISupports {
30 : public:
31 :
32 : NS_DECLARE_STATIC_IID_ACCESSOR(MOZISPELLCHECKINGENGINE_IID)
33 :
34 : /* attribute wstring dictionary; */
35 : NS_IMETHOD GetDictionary(char16_t * *aDictionary) = 0;
36 : NS_IMETHOD SetDictionary(const char16_t * aDictionary) = 0;
37 :
38 : /* readonly attribute wstring language; */
39 : NS_IMETHOD GetLanguage(char16_t * *aLanguage) = 0;
40 :
41 : /* readonly attribute boolean providesPersonalDictionary; */
42 : NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) = 0;
43 :
44 : /* readonly attribute boolean providesWordUtils; */
45 : NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) = 0;
46 :
47 : /* readonly attribute wstring name; */
48 : NS_IMETHOD GetName(char16_t * *aName) = 0;
49 :
50 : /* readonly attribute wstring copyright; */
51 : NS_IMETHOD GetCopyright(char16_t * *aCopyright) = 0;
52 :
53 : /* attribute mozIPersonalDictionary personalDictionary; */
54 : NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) = 0;
55 : NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) = 0;
56 :
57 : /* void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out uint32_t count); */
58 : NS_IMETHOD GetDictionaryList(char16_t * **dictionaries, uint32_t *count) = 0;
59 :
60 : /* boolean check (in wstring word); */
61 : NS_IMETHOD Check(const char16_t * word, bool *_retval) = 0;
62 :
63 : /* void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out uint32_t count); */
64 : NS_IMETHOD Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count) = 0;
65 :
66 : /* void loadDictionariesFromDir (in nsIFile dir); */
67 : NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) = 0;
68 :
69 : /* void addDirectory (in nsIFile dir); */
70 : NS_IMETHOD AddDirectory(nsIFile *dir) = 0;
71 :
72 : /* void removeDirectory (in nsIFile dir); */
73 : NS_IMETHOD RemoveDirectory(nsIFile *dir) = 0;
74 :
75 : };
76 :
77 : NS_DEFINE_STATIC_IID_ACCESSOR(mozISpellCheckingEngine, MOZISPELLCHECKINGENGINE_IID)
78 :
79 : /* Use this macro when declaring classes that implement this interface. */
80 : #define NS_DECL_MOZISPELLCHECKINGENGINE \
81 : NS_IMETHOD GetDictionary(char16_t * *aDictionary) override; \
82 : NS_IMETHOD SetDictionary(const char16_t * aDictionary) override; \
83 : NS_IMETHOD GetLanguage(char16_t * *aLanguage) override; \
84 : NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) override; \
85 : NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) override; \
86 : NS_IMETHOD GetName(char16_t * *aName) override; \
87 : NS_IMETHOD GetCopyright(char16_t * *aCopyright) override; \
88 : NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) override; \
89 : NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) override; \
90 : NS_IMETHOD GetDictionaryList(char16_t * **dictionaries, uint32_t *count) override; \
91 : NS_IMETHOD Check(const char16_t * word, bool *_retval) override; \
92 : NS_IMETHOD Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count) override; \
93 : NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) override; \
94 : NS_IMETHOD AddDirectory(nsIFile *dir) override; \
95 : NS_IMETHOD RemoveDirectory(nsIFile *dir) override;
96 :
97 : /* Use this macro when declaring the members of this interface when the
98 : class doesn't implement the interface. This is useful for forwarding. */
99 : #define NS_DECL_NON_VIRTUAL_MOZISPELLCHECKINGENGINE \
100 : nsresult GetDictionary(char16_t * *aDictionary); \
101 : nsresult SetDictionary(const char16_t * aDictionary); \
102 : nsresult GetLanguage(char16_t * *aLanguage); \
103 : nsresult GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary); \
104 : nsresult GetProvidesWordUtils(bool *aProvidesWordUtils); \
105 : nsresult GetName(char16_t * *aName); \
106 : nsresult GetCopyright(char16_t * *aCopyright); \
107 : nsresult GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary); \
108 : nsresult SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary); \
109 : nsresult GetDictionaryList(char16_t * **dictionaries, uint32_t *count); \
110 : nsresult Check(const char16_t * word, bool *_retval); \
111 : nsresult Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count); \
112 : nsresult LoadDictionariesFromDir(nsIFile *dir); \
113 : nsresult AddDirectory(nsIFile *dir); \
114 : nsresult RemoveDirectory(nsIFile *dir);
115 :
116 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
117 : #define NS_FORWARD_MOZISPELLCHECKINGENGINE(_to) \
118 : NS_IMETHOD GetDictionary(char16_t * *aDictionary) override { return _to GetDictionary(aDictionary); } \
119 : NS_IMETHOD SetDictionary(const char16_t * aDictionary) override { return _to SetDictionary(aDictionary); } \
120 : NS_IMETHOD GetLanguage(char16_t * *aLanguage) override { return _to GetLanguage(aLanguage); } \
121 : NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) override { return _to GetProvidesPersonalDictionary(aProvidesPersonalDictionary); } \
122 : NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) override { return _to GetProvidesWordUtils(aProvidesWordUtils); } \
123 : NS_IMETHOD GetName(char16_t * *aName) override { return _to GetName(aName); } \
124 : NS_IMETHOD GetCopyright(char16_t * *aCopyright) override { return _to GetCopyright(aCopyright); } \
125 : NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) override { return _to GetPersonalDictionary(aPersonalDictionary); } \
126 : NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) override { return _to SetPersonalDictionary(aPersonalDictionary); } \
127 : NS_IMETHOD GetDictionaryList(char16_t * **dictionaries, uint32_t *count) override { return _to GetDictionaryList(dictionaries, count); } \
128 : NS_IMETHOD Check(const char16_t * word, bool *_retval) override { return _to Check(word, _retval); } \
129 : NS_IMETHOD Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count) override { return _to Suggest(word, suggestions, count); } \
130 : NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) override { return _to LoadDictionariesFromDir(dir); } \
131 : NS_IMETHOD AddDirectory(nsIFile *dir) override { return _to AddDirectory(dir); } \
132 : NS_IMETHOD RemoveDirectory(nsIFile *dir) override { return _to RemoveDirectory(dir); }
133 :
134 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
135 : #define NS_FORWARD_SAFE_MOZISPELLCHECKINGENGINE(_to) \
136 : NS_IMETHOD GetDictionary(char16_t * *aDictionary) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionary(aDictionary); } \
137 : NS_IMETHOD SetDictionary(const char16_t * aDictionary) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetDictionary(aDictionary); } \
138 : NS_IMETHOD GetLanguage(char16_t * *aLanguage) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLanguage(aLanguage); } \
139 : NS_IMETHOD GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProvidesPersonalDictionary(aProvidesPersonalDictionary); } \
140 : NS_IMETHOD GetProvidesWordUtils(bool *aProvidesWordUtils) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProvidesWordUtils(aProvidesWordUtils); } \
141 : NS_IMETHOD GetName(char16_t * *aName) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetName(aName); } \
142 : NS_IMETHOD GetCopyright(char16_t * *aCopyright) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCopyright(aCopyright); } \
143 : NS_IMETHOD GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPersonalDictionary(aPersonalDictionary); } \
144 : NS_IMETHOD SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetPersonalDictionary(aPersonalDictionary); } \
145 : NS_IMETHOD GetDictionaryList(char16_t * **dictionaries, uint32_t *count) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDictionaryList(dictionaries, count); } \
146 : NS_IMETHOD Check(const char16_t * word, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Check(word, _retval); } \
147 : NS_IMETHOD Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count) override { return !_to ? NS_ERROR_NULL_POINTER : _to->Suggest(word, suggestions, count); } \
148 : NS_IMETHOD LoadDictionariesFromDir(nsIFile *dir) override { return !_to ? NS_ERROR_NULL_POINTER : _to->LoadDictionariesFromDir(dir); } \
149 : NS_IMETHOD AddDirectory(nsIFile *dir) override { return !_to ? NS_ERROR_NULL_POINTER : _to->AddDirectory(dir); } \
150 : NS_IMETHOD RemoveDirectory(nsIFile *dir) override { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveDirectory(dir); }
151 :
152 : #if 0
153 : /* Use the code below as a template for the implementation class for this interface. */
154 :
155 : /* Header file */
156 : class _MYCLASS_ : public mozISpellCheckingEngine
157 : {
158 : public:
159 : NS_DECL_ISUPPORTS
160 : NS_DECL_MOZISPELLCHECKINGENGINE
161 :
162 : _MYCLASS_();
163 :
164 : private:
165 : ~_MYCLASS_();
166 :
167 : protected:
168 : /* additional members */
169 : };
170 :
171 : /* Implementation file */
172 : NS_IMPL_ISUPPORTS(_MYCLASS_, mozISpellCheckingEngine)
173 :
174 : _MYCLASS_::_MYCLASS_()
175 : {
176 : /* member initializers and constructor code */
177 : }
178 :
179 : _MYCLASS_::~_MYCLASS_()
180 : {
181 : /* destructor code */
182 : }
183 :
184 : /* attribute wstring dictionary; */
185 : NS_IMETHODIMP _MYCLASS_::GetDictionary(char16_t * *aDictionary)
186 : {
187 : return NS_ERROR_NOT_IMPLEMENTED;
188 : }
189 : NS_IMETHODIMP _MYCLASS_::SetDictionary(const char16_t * aDictionary)
190 : {
191 : return NS_ERROR_NOT_IMPLEMENTED;
192 : }
193 :
194 : /* readonly attribute wstring language; */
195 : NS_IMETHODIMP _MYCLASS_::GetLanguage(char16_t * *aLanguage)
196 : {
197 : return NS_ERROR_NOT_IMPLEMENTED;
198 : }
199 :
200 : /* readonly attribute boolean providesPersonalDictionary; */
201 : NS_IMETHODIMP _MYCLASS_::GetProvidesPersonalDictionary(bool *aProvidesPersonalDictionary)
202 : {
203 : return NS_ERROR_NOT_IMPLEMENTED;
204 : }
205 :
206 : /* readonly attribute boolean providesWordUtils; */
207 : NS_IMETHODIMP _MYCLASS_::GetProvidesWordUtils(bool *aProvidesWordUtils)
208 : {
209 : return NS_ERROR_NOT_IMPLEMENTED;
210 : }
211 :
212 : /* readonly attribute wstring name; */
213 : NS_IMETHODIMP _MYCLASS_::GetName(char16_t * *aName)
214 : {
215 : return NS_ERROR_NOT_IMPLEMENTED;
216 : }
217 :
218 : /* readonly attribute wstring copyright; */
219 : NS_IMETHODIMP _MYCLASS_::GetCopyright(char16_t * *aCopyright)
220 : {
221 : return NS_ERROR_NOT_IMPLEMENTED;
222 : }
223 :
224 : /* attribute mozIPersonalDictionary personalDictionary; */
225 : NS_IMETHODIMP _MYCLASS_::GetPersonalDictionary(mozIPersonalDictionary * *aPersonalDictionary)
226 : {
227 : return NS_ERROR_NOT_IMPLEMENTED;
228 : }
229 : NS_IMETHODIMP _MYCLASS_::SetPersonalDictionary(mozIPersonalDictionary *aPersonalDictionary)
230 : {
231 : return NS_ERROR_NOT_IMPLEMENTED;
232 : }
233 :
234 : /* void getDictionaryList ([array, size_is (count)] out wstring dictionaries, out uint32_t count); */
235 : NS_IMETHODIMP _MYCLASS_::GetDictionaryList(char16_t * **dictionaries, uint32_t *count)
236 : {
237 : return NS_ERROR_NOT_IMPLEMENTED;
238 : }
239 :
240 : /* boolean check (in wstring word); */
241 : NS_IMETHODIMP _MYCLASS_::Check(const char16_t * word, bool *_retval)
242 : {
243 : return NS_ERROR_NOT_IMPLEMENTED;
244 : }
245 :
246 : /* void suggest (in wstring word, [array, size_is (count)] out wstring suggestions, out uint32_t count); */
247 : NS_IMETHODIMP _MYCLASS_::Suggest(const char16_t * word, char16_t * **suggestions, uint32_t *count)
248 : {
249 : return NS_ERROR_NOT_IMPLEMENTED;
250 : }
251 :
252 : /* void loadDictionariesFromDir (in nsIFile dir); */
253 : NS_IMETHODIMP _MYCLASS_::LoadDictionariesFromDir(nsIFile *dir)
254 : {
255 : return NS_ERROR_NOT_IMPLEMENTED;
256 : }
257 :
258 : /* void addDirectory (in nsIFile dir); */
259 : NS_IMETHODIMP _MYCLASS_::AddDirectory(nsIFile *dir)
260 : {
261 : return NS_ERROR_NOT_IMPLEMENTED;
262 : }
263 :
264 : /* void removeDirectory (in nsIFile dir); */
265 : NS_IMETHODIMP _MYCLASS_::RemoveDirectory(nsIFile *dir)
266 : {
267 : return NS_ERROR_NOT_IMPLEMENTED;
268 : }
269 :
270 : /* End of implementation class template. */
271 : #endif
272 :
273 : #define DICTIONARY_SEARCH_DIRECTORY "DictD"
274 : #define DICTIONARY_SEARCH_DIRECTORY_LIST "DictDL"
275 : #define SPELLCHECK_DICTIONARY_REMOVE_NOTIFICATION \
276 : "spellcheck-dictionary-remove"
277 :
278 : #endif /* __gen_mozISpellCheckingEngine_h__ */
|
