Back to index

lightning-sunbird  0.9+nobinonly
nsIMsgSearchNotify.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alec Flett <alecf@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00041 interface nsIMsgDBHdr;
00042 interface nsIMsgSearchSession;
00043 interface nsIMsgFolder;
00044 
00045 // when a search is run, this interface is passed in as a listener
00046 // on the search.
00047 [scriptable, uuid(ca37784d-352b-4c39-8ccb-0abc1a93f681)]
00048 interface nsIMsgSearchNotify : nsISupports
00049 {
00050   void onSearchHit(in nsIMsgDBHdr header, in nsIMsgFolder folder);
00051 
00052   // notification that a search has finished.
00053   void onSearchDone(in nsresult status);
00054   /*
00055    * until we can encode searches with a URI, this will be an
00056    * out-of-bound way to connect a set of search terms to a datasource
00057    */
00058 
00059   /*
00060    * called when a new search begins
00061    */
00062   void onNewSearch();
00063 };
00064