xpfe/components/autocomplete/public/nsIAutoCompleteListener.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Dan Mosedale <dmose@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "nsIAutoCompleteResults.idl"
  41
  42
  43 typedef long AutoCompleteStatus;
  44
  45 [scriptable, uuid(4BA0A180-097C-11d4-A449-CD1A8B47ED7C)]
  46 interface nsIAutoCompleteStatus {
  47     const long failed           = -1;
  48     const long noMatch          = 0;
  49     const long matchFound       = 1;
  50     const long ignored          = 2;
  51
  52     // like failed, in that no successful matches were found, however,
  53     // results should be displayed anyway, because they contain info about
  54     // the failure in question
  55     //
  56     const long failureItems     = 3;
  57
  58     // the following status values indicate that the async search hasn't ended
  59     const long noMatchYet       = 4;
  60     const long matchSoFar       = 5;
  61 };
  62
  63 [scriptable, uuid(4BA0A181-097C-11d4-A449-CD1A8B47ED7C)]
  64 interface nsIAutoCompleteListener : nsISupports {
  65
  66     /* onStatus is called by the autocomplete session during the search */
  67     void onStatus(in wstring statusText);
  68
  69     /* onAutoComplete is called by the autocomplete session when the search is done or over */
  70     void onAutoComplete(in nsIAutoCompleteResults result, in AutoCompleteStatus status);
  71
  72     /* private param used by the autocomplete widget */
  73     attribute nsISupports param;
  74 };