toolkit/components/autocomplete/public/nsIAutoCompleteResultTypes.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 Communicator client 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) 1998
  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 "nsIAutoCompleteResult.idl"
  39
  40 interface nsIMdbTable;
  41 interface nsIMdbEnv;
  42 interface nsIMdbRow;
  43
  44 %{ C++
  45 #include "mdb.h"
  46 %}
  47
  48 native mdb_scope(mdb_scope);
  49 native mdb_column(mdb_column);
  50
  51 /* noscript */
  52 [uuid(e6396544-921d-4776-aa62-8bf2dc1ae058)]
  53 interface nsIAutoCompleteBaseResult : nsIAutoCompleteResult
  54 {
  55   void setSearchString(in AString searchString);
  56   void setErrorDescription(in AString errorDescription);
  57   void setDefaultIndex(in long defaultIndex);
  58   void setSearchResult(in unsigned long searchResult);
  59 };
  60
  61 /* noscript */
  62 [uuid(f7e7b341-2d5c-4d04-9f51-496cb2ce178c)]
  63 interface nsIAutoCompleteMdbResult : nsIAutoCompleteBaseResult
  64 {
  65   const short kUnicharType = 0;
  66   const short kCharType    = 1;
  67   const short kIntType     = 2;
  68
  69   void init(in nsIMdbEnv env, in nsIMdbTable table);
  70
  71   void setTokens(in mdb_scope valueToken, in short valueType,
  72                  in mdb_scope commentToken, in short commentType);
  73
  74   void addRow(in nsIMdbRow row);
  75
  76   nsIMdbRow getRowAt(in unsigned long rowIndex);
  77
  78   AString getRowValue(in nsIMdbRow row, in mdb_column col);
  79
  80   AUTF8String getUTF8RowValue(in nsIMdbRow row, in mdb_column col);
  81
  82   long getIntRowValue(in nsIMdbRow row, in mdb_column col);
  83 };
  84
  85 /* noscript */
  86 [uuid(148C9DC5-0FBB-408B-80FE-544F6A85B433)]
  87 interface nsIAutoCompleteMdbResult2 : nsIAutoCompleteMdbResult
  88 {
  89   attribute boolean reverseByteOrder;
  90 };