Back to index

lightning-sunbird  0.9+nobinonly
nsIAutoCompleteListener.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Dan Mosedale <dmose@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 #include "nsIAutoCompleteResults.idl"
00041 
00042 
00043 typedef long AutoCompleteStatus;
00044 
00045 [scriptable, uuid(4BA0A180-097C-11d4-A449-CD1A8B47ED7C)]
00046 interface nsIAutoCompleteStatus {
00047     const long failed           = -1;
00048     const long noMatch          = 0;
00049     const long matchFound       = 1;
00050     const long ignored          = 2;
00051 
00052     // like failed, in that no successful matches were found, however,
00053     // results should be displayed anyway, because they contain info about  
00054     // the failure in question
00055     //
00056     const long failureItems     = 3;    
00057 };
00058 
00059 [scriptable, uuid(4BA0A181-097C-11d4-A449-CD1A8B47ED7C)]
00060 interface nsIAutoCompleteListener : nsISupports {
00061 
00062     /* onStatus is called by the autocomplete session during the seach */
00063     void onStatus(in wstring statusText);
00064 
00065     /* onAutoComplete is called by the autocomplete session when the search is done or over */
00066     void onAutoComplete(in nsIAutoCompleteResults result, in AutoCompleteStatus status);
00067     
00068     /* private param used by the autocomplete widget */
00069     attribute nsISupports param;
00070 };