gecko/toolkit/components/autocomplete/nsIAutoCompletePopup.idl

63 lines
1.8 KiB
Plaintext
Raw Normal View History

2012-05-21 04:12:37 -07:00
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIDOMElement;
interface nsIAutoCompleteInput;
[scriptable, uuid(1b9d7d8a-6dd0-11dc-8314-0800200c9a66)]
interface nsIAutoCompletePopup : nsISupports
{
/*
* The input object that the popup is currently bound to
*/
readonly attribute nsIAutoCompleteInput input;
/*
* An alternative value to be used when text is entered, rather than the
* value of the selected item
*/
readonly attribute AString overrideValue;
/*
* The index of the result item that is currently selected
*/
attribute long selectedIndex;
/*
* Indicates if the popup is currently open
*/
readonly attribute boolean popupOpen;
/*
* Bind the popup to an input object and display it with the given coordinates
*
* @param input - The input object that the popup will be bound to
* @param element - The element that the popup will be aligned with
*/
void openAutocompletePopup(in nsIAutoCompleteInput input, in nsIDOMElement element);
/*
* Close the popup and detach from the bound input
*/
void closePopup();
/*
* Instruct the result view to repaint itself to reflect the most current
* underlying data
*/
void invalidate();
/*
* Change the selection relative to the current selection and make sure
* the newly selected row is visible
*
* @param reverse - Select a row above the current selection
* @param page - Select a row that is a full visible page from the current selection
* @return The currently selected result item index
*/
void selectBy(in boolean reverse, in boolean page);
};