toolkit/components/autocomplete/nsIAutoCompletePopup.idl@6474c204b198 (annotated)
toolkit/components/autocomplete/nsIAutoCompletePopup.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 2 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 3 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 4 | |
| michael@0 | 5 | #include "nsISupports.idl" |
| michael@0 | 6 | |
| michael@0 | 7 | interface nsIDOMElement; |
| michael@0 | 8 | interface nsIAutoCompleteInput; |
| michael@0 | 9 | |
| michael@0 | 10 | [scriptable, uuid(1b9d7d8a-6dd0-11dc-8314-0800200c9a66)] |
| michael@0 | 11 | interface nsIAutoCompletePopup : nsISupports |
| michael@0 | 12 | { |
| michael@0 | 13 | /* |
| michael@0 | 14 | * The input object that the popup is currently bound to |
| michael@0 | 15 | */ |
| michael@0 | 16 | readonly attribute nsIAutoCompleteInput input; |
| michael@0 | 17 | |
| michael@0 | 18 | /* |
| michael@0 | 19 | * An alternative value to be used when text is entered, rather than the |
| michael@0 | 20 | * value of the selected item |
| michael@0 | 21 | */ |
| michael@0 | 22 | readonly attribute AString overrideValue; |
| michael@0 | 23 | |
| michael@0 | 24 | /* |
| michael@0 | 25 | * The index of the result item that is currently selected |
| michael@0 | 26 | */ |
| michael@0 | 27 | attribute long selectedIndex; |
| michael@0 | 28 | |
| michael@0 | 29 | /* |
| michael@0 | 30 | * Indicates if the popup is currently open |
| michael@0 | 31 | */ |
| michael@0 | 32 | readonly attribute boolean popupOpen; |
| michael@0 | 33 | |
| michael@0 | 34 | /* |
| michael@0 | 35 | * Bind the popup to an input object and display it with the given coordinates |
| michael@0 | 36 | * |
| michael@0 | 37 | * @param input - The input object that the popup will be bound to |
| michael@0 | 38 | * @param element - The element that the popup will be aligned with |
| michael@0 | 39 | */ |
| michael@0 | 40 | void openAutocompletePopup(in nsIAutoCompleteInput input, in nsIDOMElement element); |
| michael@0 | 41 | |
| michael@0 | 42 | /* |
| michael@0 | 43 | * Close the popup and detach from the bound input |
| michael@0 | 44 | */ |
| michael@0 | 45 | void closePopup(); |
| michael@0 | 46 | |
| michael@0 | 47 | /* |
| michael@0 | 48 | * Instruct the result view to repaint itself to reflect the most current |
| michael@0 | 49 | * underlying data |
| michael@0 | 50 | */ |
| michael@0 | 51 | void invalidate(); |
| michael@0 | 52 | |
| michael@0 | 53 | /* |
| michael@0 | 54 | * Change the selection relative to the current selection and make sure |
| michael@0 | 55 | * the newly selected row is visible |
| michael@0 | 56 | * |
| michael@0 | 57 | * @param reverse - Select a row above the current selection |
| michael@0 | 58 | * @param page - Select a row that is a full visible page from the current selection |
| michael@0 | 59 | * @return The currently selected result item index |
| michael@0 | 60 | */ |
| michael@0 | 61 | void selectBy(in boolean reverse, in boolean page); |
| michael@0 | 62 | }; |
