RetroZilla/extensions/spellcheck/idl/mozISpellI18NUtil.idl
2015-10-20 23:03:22 -04:00

80 lines
3.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* David Einstein.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
[scriptable, uuid(B075D5DC-1DF1-441A-BEBF-680D8CAAA19C)]
/**
* This interface contains various I18N related code used in various places by the spell checker.
*/
interface mozISpellI18NUtil : nsISupports {
const PRUint32 kCheck=0;
const PRUint32 kSuggest=1;
/**
* The language being used to check spelling
*/
readonly attribute wstring language;
/**
* Given a word return a list of possible root forms of that word
*/
void getRootForm(in wstring word,
in PRUint32 type,
[array, size_is(count)] out wstring words,
out PRUint32 count);
/**
* Given a word return a list of possible root forms of that word
*/
void fromRootForm(in wstring word,
[array, size_is(icount)] in wstring iwords,
in PRUint32 icount,
[array, size_is(ocount)] out wstring owords,
out PRUint32 ocount);
/**
* Given a unicode string and an offset, find the beginning and end of the
* next word. begin and end are -1 if there are no words remaining in the
* string. This should really be folded into the Line/WordBreaker.
*/
void findNextWord(in wstring word, in PRUint32 length, in PRUint32 offset, out PRInt32 begin, out PRInt32 end);
};