Back to index

lightning-sunbird  0.9+nobinonly
mozIPersonalDictionary.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * David Einstein.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIStringEnumerator;
00041 
00042 [scriptable, uuid(7EF52EAF-B7E1-462B-87E2-5D1DBACA9048)]
00043 
00048 interface mozIPersonalDictionary : nsISupports {
00049 
00053   void load();
00054 
00058   void save();
00059 
00063   readonly attribute nsIStringEnumerator wordList;
00064 
00068   boolean check(in wstring word, in wstring lang);
00069 
00073   void addWord(in wstring word, in wstring lang);
00074 
00078   void removeWord(in wstring word, in wstring lang);
00079 
00083   void ignoreWord(in wstring word);
00084 
00088   void endSession();
00089 
00098   void addCorrection(in wstring word,in wstring correction, in wstring lang);
00099 
00103   void removeCorrection(in wstring word,in wstring correction, in wstring lang);
00104 
00108   void getCorrection(in wstring word, [array, size_is(count)] out wstring words, out PRUint32 count);
00109 };