extensions/spellcheck/idl/mozIPersonalDictionary.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIStringEnumerator;
   9
  10 /**
  11  * This interface represents a Personal Dictionary.
  12  */
  13 [scriptable, uuid(7EF52EAF-B7E1-462B-87E2-5D1DBACA9048)]
  14 interface mozIPersonalDictionary : nsISupports {
  15
  16   /**
  17    * Load the dictionary
  18    */
  19   void load();
  20
  21   /**
  22    * Save the dictionary
  23    */
  24   void save();
  25
  26   /**
  27    * Get the (lexicographically sorted) list of words
  28    */
  29   readonly attribute nsIStringEnumerator wordList;
  30
  31   /**
  32    * Check a unicode string
  33    */
  34   boolean check(in AString word);
  35
  36   /**
  37    * Add a word to the personal dictionary
  38    */
  39   void addWord(in AString word);
  40
  41   /**
  42    * Remove a word from the personal dictionary
  43    */
  44   void removeWord(in AString word);
  45
  46   /**
  47    * Add a word to the ignore all list
  48    */
  49   void ignoreWord(in AString word);
  50
  51   /**
  52    * Clear the ignore list
  53    */
  54   void endSession();
  55 };