extensions/spellcheck/idl/mozIPersonalDictionary.idl@6474c204b198 (annotated)
extensions/spellcheck/idl/mozIPersonalDictionary.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIStringEnumerator; |
| michael@0 | 9 | |
| michael@0 | 10 | [scriptable, uuid(7EF52EAF-B7E1-462B-87E2-5D1DBACA9048)] |
| michael@0 | 11 | |
| michael@0 | 12 | /** |
| michael@0 | 13 | * This interface represents a Personal Dictionary. |
| michael@0 | 14 | */ |
| michael@0 | 15 | |
| michael@0 | 16 | interface mozIPersonalDictionary : nsISupports { |
| michael@0 | 17 | |
| michael@0 | 18 | /** |
| michael@0 | 19 | * Load the dictionary |
| michael@0 | 20 | */ |
| michael@0 | 21 | void load(); |
| michael@0 | 22 | |
| michael@0 | 23 | /** |
| michael@0 | 24 | * Save the dictionary |
| michael@0 | 25 | */ |
| michael@0 | 26 | void save(); |
| michael@0 | 27 | |
| michael@0 | 28 | /** |
| michael@0 | 29 | * Get the (lexicographically sorted) list of words |
| michael@0 | 30 | */ |
| michael@0 | 31 | readonly attribute nsIStringEnumerator wordList; |
| michael@0 | 32 | |
| michael@0 | 33 | /** |
| michael@0 | 34 | * Check a unicode string |
| michael@0 | 35 | */ |
| michael@0 | 36 | boolean check(in wstring word, in wstring lang); |
| michael@0 | 37 | |
| michael@0 | 38 | /** |
| michael@0 | 39 | * Add a word to the personal dictionary |
| michael@0 | 40 | */ |
| michael@0 | 41 | void addWord(in wstring word, in wstring lang); |
| michael@0 | 42 | |
| michael@0 | 43 | /** |
| michael@0 | 44 | * Remove a word from the personal dictionary |
| michael@0 | 45 | */ |
| michael@0 | 46 | void removeWord(in wstring word, in wstring lang); |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Add a word to the ignore all list |
| michael@0 | 50 | */ |
| michael@0 | 51 | void ignoreWord(in wstring word); |
| michael@0 | 52 | |
| michael@0 | 53 | /** |
| michael@0 | 54 | * Clear the ignore list |
| michael@0 | 55 | */ |
| michael@0 | 56 | void endSession(); |
| michael@0 | 57 | |
| michael@0 | 58 | /** |
| michael@0 | 59 | * These three functions are here in case we want to store previous |
| michael@0 | 60 | * misspellings and return them at the head of the misspell list. |
| michael@0 | 61 | */ |
| michael@0 | 62 | |
| michael@0 | 63 | /** |
| michael@0 | 64 | * Add a misspelling to the list of corrections |
| michael@0 | 65 | */ |
| michael@0 | 66 | void addCorrection(in wstring word,in wstring correction, in wstring lang); |
| michael@0 | 67 | |
| michael@0 | 68 | /** |
| michael@0 | 69 | * Remove a misspelling from the list of corrections |
| michael@0 | 70 | */ |
| michael@0 | 71 | void removeCorrection(in wstring word,in wstring correction, in wstring lang); |
| michael@0 | 72 | |
| michael@0 | 73 | /** |
| michael@0 | 74 | * Get a list of previous corrections for the word |
| michael@0 | 75 | */ |
| michael@0 | 76 | void getCorrection(in wstring word, [array, size_is(count)] out wstring words, out uint32_t count); |
| michael@0 | 77 | }; |
