1
/* ***** BEGIN LICENSE BLOCK *****
2
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
4
* The contents of this file are subject to the Netscape Public License
5
* Version 1.1 (the "License"); you may not use this file except in
6
* compliance with the License. You may obtain a copy of the License at
7
* http://www.mozilla.org/NPL/
9
* Software distributed under the License is distributed on an "AS IS" basis,
10
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11
* for the specific language governing rights and limitations under the
14
* The Original Code is mozilla.org code.
16
* The Initial Developer of the Original Code is
17
* Netscape Communications Corporation.
18
* Portions created by the Initial Developer are Copyright (C) 2001
19
* the Initial Developer. All Rights Reserved.
22
* Joe Hewitt <hewitt@netscape.com> (Original Author)
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 NPL, 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 NPL, the GPL or the LGPL.
36
* ***** END LICENSE BLOCK ***** */
38
#include "nsISupports.idl"
40
interface nsIAutoCompleteResult;
41
interface nsIAutoCompleteObserver;
43
[scriptable, uuid(DE8DB85F-C1DE-4d87-94BA-7844890F91FE)]
44
interface nsIAutoCompleteSearch : nsISupports
47
* Search for a given string and notify a listener (either synchronously
48
* or asynchronously) of the result
50
* @param searchString - The string to search for
51
* @param searchParam - An extra parameter
52
* @param previousResult - A previous result to use for faster searchinig
53
* @param listener - A listener to notify when the search is complete
55
void startSearch(in AString searchString,
56
in AString searchParam,
57
in nsIAutoCompleteResult previousResult,
58
in nsIAutoCompleteObserver listener);
61
* Stop an asynchronous search that is in progress
66
[scriptable, uuid(18C36504-9A4C-4ac3-8494-BD05E00AE27F)]
67
interface nsIAutoCompleteObserver : nsISupports
70
* Called when a search is complete and the results are ready
72
* @param search - The search object that processed this search
73
* @param result - The search result object
75
void onSearchResult(in nsIAutoCompleteSearch search, in nsIAutoCompleteResult result);