extensions/spellcheck/idl/mozISpellI18NUtil.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 [scriptable, uuid(B075D5DC-1DF1-441A-BEBF-680D8CAAA19C)]
  41
  42 /**
  43  * This interface contains various I18N related code used in various places by the spell checker.
  44  */
  45
  46 interface mozISpellI18NUtil : nsISupports {
  47
  48     const PRUint32 kCheck=0;
  49     const PRUint32 kSuggest=1;
  50
  51    /**
  52     * The language being used to check spelling
  53     */
  54     readonly attribute wstring language;
  55
  56    /**
  57     * Given a word return a list of possible root forms of that word
  58     */
  59     void getRootForm(in wstring word,
  60                      in PRUint32 type,
  61                      [array, size_is(count)] out wstring words,
  62                      out PRUint32 count);
  63
  64    /**
  65     * Given a word return a list of possible root forms of that word
  66     */
  67     void fromRootForm(in wstring word,
  68                       [array, size_is(icount)] in wstring iwords,
  69                       in PRUint32 icount,
  70                       [array, size_is(ocount)] out wstring owords,
  71                       out PRUint32 ocount);
  72
  73     /**
  74      * Given a unicode string and an offset, find the beginning and end of the
  75      * next word. begin and end are -1 if there are no words remaining in the
  76      * string. This should really be folded into the Line/WordBreaker.
  77      */
  78     void findNextWord(in wstring word, in PRUint32 length, in PRUint32 offset, out PRInt32 begin, out PRInt32 end);
  79 };