extensions/spellcheck/idl/mozISpellCheckingEngine.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 mozIPersonalDictionary;
  41
  42 [scriptable, uuid(43987F7B-0FAA-4019-811E-42BECAC73FC5)]
  43
  44 /**
  45  * This interface represents a SpellChecker.
  46  */
  47
  48 interface mozISpellCheckingEngine : nsISupports {
  49   /**
  50    * The name of the current dictionary
  51    */
  52   attribute wstring dictionary;
  53
  54   /**
  55    * The language this spellchecker is using when checking
  56    */
  57   readonly attribute wstring language;
  58
  59   /**
  60    * Does the engine provide its own personal dictionary?
  61    */
  62   readonly attribute boolean providesPersonalDictionary;
  63
  64   /**
  65    * Does the engine provide its own word utils?
  66    */
  67   readonly attribute boolean providesWordUtils;
  68
  69   /**
  70    * The name of the engine
  71    */
  72   readonly attribute wstring name;
  73
  74   /**
  75    * a string indicating the copyright of the engine
  76    */
  77   readonly attribute wstring copyright;
  78
  79   /**
  80    * the personal dictionary
  81    */
  82   attribute mozIPersonalDictionary personalDictionary;
  83
  84   /**
  85    * Get the list of dictionaries
  86    */
  87   void getDictionaryList([array, size_is(count)] out wstring dictionaries, out PRUint32 count);
  88
  89   /**
  90    * check a word
  91    */
  92   boolean check(in wstring word);
  93
  94   /**
  95    * get a list of suggestions for a misspelled word
  96    */
  97   void suggest(in wstring word,[array, size_is(count)] out wstring suggestions, out PRUint32 count);
  98 };
  99
 100 %{C++
 101 #define DICTIONARY_SEARCH_DIRECTORY "DictD"
 102 #define DICTIONARY_SEARCH_DIRECTORY_LIST "DictDL"
 103 %}