blob: 95784b14123e79755387aeb494d696e66e25e333 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIFile;
interface mozIPersonalDictionary;
[scriptable, uuid(8ba643a4-7ddc-4662-b976-7ec123843f10)]
/**
* This interface represents a SpellChecker.
*/
interface mozISpellCheckingEngine : nsISupports {
/**
* The name of the current dictionary. Is either a value from
* getDictionaryList or the empty string if no dictionary is selected.
* Setting this attribute to a value not in getDictionaryList will throw
* NS_ERROR_FILE_NOT_FOUND.
*
* If the dictionary is changed to no dictionary (the empty string), an
* observer is allowed to set another dictionary before it returns.
*/
attribute wstring dictionary;
/**
* The language this spellchecker is using when checking
*/
readonly attribute wstring language;
/**
* Does the engine provide its own personal dictionary?
*/
readonly attribute boolean providesPersonalDictionary;
/**
* Does the engine provide its own word utils?
*/
readonly attribute boolean providesWordUtils;
/**
* The name of the engine
*/
readonly attribute wstring name;
/**
* a string indicating the copyright of the engine
*/
readonly attribute wstring copyright;
/**
* the personal dictionary
*/
attribute mozIPersonalDictionary personalDictionary;
/**
* Get the list of dictionaries
*/
void getDictionaryList([array, size_is(count)] out wstring dictionaries, out uint32_t count);
/**
* check a word
*/
boolean check(in wstring word);
/**
* get a list of suggestions for a misspelled word
*/
void suggest(in wstring word,[array, size_is(count)] out wstring suggestions, out uint32_t count);
/**
* Load dictionaries from the specified dir
*/
void loadDictionariesFromDir(in nsIFile dir);
/**
* Add dictionaries from a directory to the spell checker
*/
void addDirectory(in nsIFile dir);
/**
* Remove dictionaries from a directory from the spell checker
*/
void removeDirectory(in nsIFile dir);
};
%{C++
#define DICTIONARY_SEARCH_DIRECTORY "DictD"
#define DICTIONARY_SEARCH_DIRECTORY_LIST "DictDL"
#define SPELLCHECK_DICTIONARY_REMOVE_NOTIFICATION \
"spellcheck-dictionary-remove"
%}
|
