/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface mozIPersonalDictionary;

[scriptable, uuid(781E555A-51CA-47a7-88BF-BF306A062DC0)]

/**
  This interface represents a SpellChecker.
*/

interface mozISpellCheckingEngine : nsISupports {
  /* The name of the current dictionary */
  attribute wstring dictionary;

  /* The charset that we are using, somone may want to know. */
  readonly attribute wstring charset;

  /* The language we think that we're checking */
  readonly attribute wstring language;

  /* Does the engine provide its own PD? */
  readonly attribute boolean providesPersonalDictionary;

  /* Does the engine provide its own word utils? */
  readonly attribute boolean providesWordUtils;

  /* The name of the engine */
  readonly attribute wstring name;

  /* The name of the engine */
  readonly attribute wstring copyright;

  /* the personal dictionary */
  attribute mozIPersonalDictionary personalDictionary;

  /* Get the list of dictionaries */
  void GetDictionaryList([array, size_is(count)] out wstring dictionaries, out PRUint32 count);

  /* check a word */
  boolean Check(in wstring word);

  /* get a list of suggestions for a misspelled word */
  void Suggest(in wstring word,[array, size_is(count)] out wstring suggestions, out PRUint32 count);
};
