toolkit/components/autocomplete/public/nsIAutoCompleteResult.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2001
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Joe Hewitt <hewitt@netscape.com> (Original Author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 [scriptable, uuid(d2fcba9a-3f5c-40fc-a9fc-4adc87dc61ef)]
  41 interface nsIAutoCompleteResult : nsISupports
  42 {
  43   /**
  44    * Possible values for the searchResult attribute
  45    */
  46   const unsigned short RESULT_IGNORED = 1; /* indicates invalid searchString */
  47   const unsigned short RESULT_FAILURE = 2; /* indicates failure */
  48   const unsigned short RESULT_NOMATCH = 3; /* indicates success with no matches
  49                                               and that the search is complete */
  50   const unsigned short RESULT_SUCCESS = 4; /* indicates success with matches
  51                                               and that the search is complete */
  52   const unsigned short RESULT_NOMATCH_ONGOING = 5; /* indicates success
  53                                                       with no matches
  54                                                       and that the search
  55                                                       is still ongoing */
  56   const unsigned short RESULT_SUCCESS_ONGOING = 6; /* indicates success
  57                                                       with matches
  58                                                       and that the search
  59                                                       is still ongoing */
  60   /**
  61    * The original search string
  62    */
  63   readonly attribute AString searchString;
  64
  65   /**
  66    * The result of the search
  67    */
  68   readonly attribute unsigned short searchResult;
  69
  70   /**
  71    * Index of the default item that should be entered if none is selected
  72    */
  73   readonly attribute long defaultIndex;
  74
  75   /**
  76    * A string describing the cause of a search failure
  77    */
  78   readonly attribute AString errorDescription;
  79
  80   /**
  81    * The number of matches
  82    */
  83   readonly attribute unsigned long matchCount;
  84
  85   /**
  86    * Get the value of the result at the given index
  87    */
  88   AString getValueAt(in long index);
  89
  90   /**
  91    * Get the comment of the result at the given index
  92    */
  93   AString getCommentAt(in long index);
  94
  95   /**
  96    * Get the style hint for the result at the given index
  97    */
  98   AString getStyleAt(in long index);
  99
 100   /**
 101    * Get the image of the result at the given index
 102    */
 103   AString getImageAt(in long index);
 104
 105   /**
 106    * Remove the value at the given index from the autocomplete results.
 107    * If removeFromDb is set to true, the value should be removed from
 108    * persistent storage as well.
 109    */
 110   void removeValueAt(in long rowIndex, in boolean removeFromDb);
 111 };