mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 00:25:27 +00:00
84 lines
3.2 KiB
Plaintext
84 lines
3.2 KiB
Plaintext
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla 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/MPL/
|
|
*
|
|
* 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
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Joe Hewitt <hewitt@netscape.com> (original author)
|
|
*
|
|
* 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 MPL, 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 MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsAString;
|
|
interface inISearchObserver;
|
|
interface nsISupportsArray;
|
|
|
|
[scriptable, uuid(D5FA765B-2448-4686-B7C1-5FF13ACB0FC9)]
|
|
interface inISearchProcess : nsISupports
|
|
{
|
|
// indicates if an asynchronous search is in progress
|
|
readonly attribute boolean isActive;
|
|
|
|
// the number of results returned
|
|
readonly attribute long resultCount;
|
|
|
|
// for optimization when doing an async search, this will optionally
|
|
// destroy old results, assuming they will be fetched as soon as
|
|
// the observer is notified of their presence. If true, then indices
|
|
// pass to the get*ResultAt methods will return null for any index
|
|
// other than the most recent one, and getResults will return null always.
|
|
attribute boolean holdResults;
|
|
|
|
// start a synchronous search
|
|
void searchSync();
|
|
|
|
// start an asynchronous search
|
|
void searchAsync(in inISearchObserver aObserver);
|
|
|
|
// command an async process to stop immediately
|
|
void searchStop();
|
|
|
|
// performs a step in the asynchronous search loop
|
|
// return indicates true if loop is done, false if it should continue
|
|
// This is there only for the benefit of asynchronous search controllers,
|
|
// and is not for use by those who just wish to call searchAsync
|
|
boolean searchStep();
|
|
|
|
// methods for getting results of specific types
|
|
|
|
AString getStringResultAt(in long aIndex);
|
|
|
|
long getIntResultAt(in long aIndex);
|
|
|
|
unsigned long getUIntResultAt(in long aIndex);
|
|
};
|