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 interface nsIDOMElement;
41 interface nsIAutoCompleteInput;
42
43 [scriptable, uuid(1b9d7d8a-6dd0-11dc-8314-0800200c9a66)]
44 interface nsIAutoCompletePopup : nsISupports
45 {
46 /*
47 * The input object that the popup is currently bound to
48 */
49 readonly attribute nsIAutoCompleteInput input;
50
51 /*
52 * An alternative value to be used when text is entered, rather than the
53 * value of the selected item
54 */
55 readonly attribute AString overrideValue;
56
57 /*
58 * The index of the result item that is currently selected
59 */
60 attribute long selectedIndex;
61
62 /*
63 * Indicates if the popup is currently open
64 */
65 readonly attribute boolean popupOpen;
66
67 /*
68 * Bind the popup to an input object and display it with the given coordinates
69 *
70 * @param input - The input object that the popup will be bound to
71 * @param element - The element that the popup will be aligned with
72 */
73 void openAutocompletePopup(in nsIAutoCompleteInput input, in nsIDOMElement element);
74
75 /*
76 * Close the popup and detach from the bound input
77 */
78 void closePopup();
79
80 /*
81 * Instruct the result view to repaint itself to reflect the most current
82 * underlying data
83 */
84 void invalidate();
85
86 /*
87 * Change the selection relative to the current selection and make sure
88 * the newly selected row is visible
89 *
90 * @param reverse - Select a row above the current selection
91 * @param page - Select a row that is a full visible page from the current selection
92 * @return The currently selected result item index
93 */
94 void selectBy(in boolean reverse, in boolean page);
95 };