summaryrefslogtreecommitdiffstats
path: root/extensions/spellcheck/idl/mozIPersonalDictionary.idl
blob: 61cdf4c48d262cbcb3289a2b2ce5ae5deb3821d2 (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
/* -*- 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 nsIStringEnumerator;

/**
 * This interface represents a Personal Dictionary.
 */
[scriptable, uuid(7EF52EAF-B7E1-462B-87E2-5D1DBACA9048)]
interface mozIPersonalDictionary : nsISupports {

  /**
   * Load the dictionary
   */
  void load();

  /**
   * Save the dictionary
   */
  void save();

  /**
   * Get the (lexicographically sorted) list of words
   */
  readonly attribute nsIStringEnumerator wordList;

  /**
   * Check a unicode string
   */
  boolean check(in AString word);

  /**
   * Add a word to the personal dictionary
   */
  void addWord(in AString word);

  /**
   * Remove a word from the personal dictionary
   */
  void removeWord(in AString word);

  /**
   * Add a word to the ignore all list
   */
  void ignoreWord(in AString word);

  /**
   * Clear the ignore list
   */
  void endSession();
};