extensions/spellcheck/idl/mozIPersonalDictionary.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * David Einstein.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIStringEnumerator;
  41
  42 [scriptable, uuid(7EF52EAF-B7E1-462B-87E2-5D1DBACA9048)]
  43
  44 /**
  45  * This interface represents a Personal Dictionary.
  46  */
  47
  48 interface mozIPersonalDictionary : nsISupports {
  49
  50   /**
  51    * Load the dictionary
  52    */
  53   void load();
  54
  55   /**
  56    * Save the dictionary
  57    */
  58   void save();
  59
  60   /**
  61    * Get the (lexicographically sorted) list of words
  62    */
  63   readonly attribute nsIStringEnumerator wordList;
  64
  65   /**
  66    * Check a unicode string
  67    */
  68   boolean check(in wstring word, in wstring lang);
  69
  70   /**
  71    * Add a word to the personal dictionary
  72    */
  73   void addWord(in wstring word, in wstring lang);
  74
  75   /**
  76    * Remove a word from the personal dictionary
  77    */
  78   void removeWord(in wstring word, in wstring lang);
  79
  80   /**
  81    * Add a word to the ignore all list
  82    */
  83   void ignoreWord(in wstring word);
  84
  85   /**
  86    * Clear the ignore list
  87    */
  88   void endSession();
  89
  90   /**
  91    * These three functions are here in case we want to store previous
  92    * misspellings and return them at the head of the misspell list.
  93    */
  94
  95   /**
  96    * Add a misspelling to the list of corrections
  97    */
  98   void addCorrection(in wstring word,in wstring correction, in wstring lang);
  99
 100   /**
 101    * Remove a misspelling from the list of corrections
 102    */
 103   void removeCorrection(in wstring word,in wstring correction, in wstring lang);
 104
 105   /**
 106    * Get a list of previous corrections for the word
 107    */
 108   void getCorrection(in wstring word, [array, size_is(count)] out wstring words, out PRUint32 count);
 109 };