1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
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
12 * License.
13 *
14 * The Original Code is mozilla.org code.
15 *
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.
20 *
21 * Contributor(s):
22 * Joe Hewitt <hewitt@netscape.com> (original author)
23 *
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 MPL, 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 MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38
39 #include "nsISupports.idl"
40
41 interface nsAString;
42 interface inISearchObserver;
43 interface nsISupportsArray;
44
45 [scriptable, uuid(D5FA765B-2448-4686-B7C1-5FF13ACB0FC9)]
46 interface inISearchProcess : nsISupports
47 {
48 // indicates if an asynchronous search is in progress
49 readonly attribute boolean isActive;
50
51 // the number of results returned
52 readonly attribute long resultCount;
53
54 // for optimization when doing an async search, this will optionally
55 // destroy old results, assuming they will be fetched as soon as
56 // the observer is notified of their presence. If true, then indices
57 // pass to the get*ResultAt methods will return null for any index
58 // other than the most recent one, and getResults will return null always.
59 attribute boolean holdResults;
60
61 // start a synchronous search
62 void searchSync();
63
64 // start an asynchronous search
65 void searchAsync(in inISearchObserver aObserver);
66
67 // command an async process to stop immediately
68 void searchStop();
69
70 // performs a step in the asynchronous search loop
71 // return indicates true if loop is done, false if it should continue
72 // This is there only for the benefit of asynchronous search controllers,
73 // and is not for use by those who just wish to call searchAsync
74 boolean searchStep();
75
76 // methods for getting results of specific types
77
78 AString getStringResultAt(in long aIndex);
79
80 long getIntResultAt(in long aIndex);
81
82 unsigned long getUIntResultAt(in long aIndex);
83 };