Back to index

lightning-sunbird  0.9+nobinonly
inISearchProcess.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 
00039 #include "nsISupports.idl"
00040 
00041 interface nsAString;
00042 interface inISearchObserver;
00043 interface nsISupportsArray;
00044 
00045 [scriptable, uuid(D5FA765B-2448-4686-B7C1-5FF13ACB0FC9)]
00046 interface inISearchProcess : nsISupports
00047 {
00048   // indicates if an asynchronous search is in progress
00049   readonly attribute boolean isActive;
00050 
00051   // the number of results returned 
00052   readonly attribute long resultCount;
00053 
00054   // for optimization when doing an async search, this will optionally
00055   // destroy old results, assuming they will be fetched as soon as 
00056   // the observer is notified of their presence.  If true, then indices
00057   // pass to the get*ResultAt methods will return null for any index
00058   // other than the most recent one, and getResults will return null always.
00059   attribute boolean holdResults;
00060 
00061   // start a synchronous search
00062   void searchSync();
00063 
00064   // start an asynchronous search
00065   void searchAsync(in inISearchObserver aObserver);
00066 
00067   // command an async process to stop immediately
00068   void searchStop();
00069 
00070   // performs a step in the asynchronous search loop
00071   // return indicates true if loop is done, false if it should continue
00072   // This is there only for the benefit of asynchronous search controllers,
00073   // and is not for use by those who just wish to call searchAsync
00074   boolean searchStep();
00075 
00076   // methods for getting results of specific types
00077   
00078   AString getStringResultAt(in long aIndex);
00079   
00080   long getIntResultAt(in long aIndex);
00081   
00082   unsigned long getUIntResultAt(in long aIndex);
00083 };