Back to index

lightning-sunbird  0.9+nobinonly
nsIAutoCompleteSearch.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2001
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Joe Hewitt <hewitt@netscape.com> (Original Author)
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 nsIAutoCompleteResult;
00041 interface nsIAutoCompleteObserver;
00042 
00043 [scriptable, uuid(DE8DB85F-C1DE-4d87-94BA-7844890F91FE)]
00044 interface nsIAutoCompleteSearch : nsISupports
00045 {
00046   /*
00047    * Search for a given string and notify a listener (either synchronously
00048    * or asynchronously) of the result
00049    *
00050    * @param searchString - The string to search for
00051    * @param searchParam - An extra parameter
00052    * @param previousResult - A previous result to use for faster searchinig
00053    * @param listener - A listener to notify when the search is complete
00054    */
00055   void startSearch(in AString searchString,
00056                    in AString searchParam,
00057                    in nsIAutoCompleteResult previousResult,
00058                    in nsIAutoCompleteObserver listener);
00059 
00060   /*
00061    * Stop an asynchronous search that is in progress
00062    */
00063   void stopSearch();
00064 };
00065 
00066 [scriptable, uuid(18C36504-9A4C-4ac3-8494-BD05E00AE27F)]
00067 interface nsIAutoCompleteObserver : nsISupports
00068 { 
00069   /*
00070    * Called when a search is complete and the results are ready
00071    *
00072    * @param search - The search object that processed this search
00073    * @param result - The search result object
00074    */
00075   void onSearchResult(in nsIAutoCompleteSearch search, in nsIAutoCompleteResult result);
00076 };