Back to index

lightning-sunbird  0.9+nobinonly
nsIAutoCompletePopup.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2001
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Joe Hewitt <hewitt@netscape.com> (Original Author)
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIAutoCompleteInput;
00041 
00042 [scriptable, uuid(65F6CD46-22EC-4329-BB3B-BCD1103F2204)]
00043 interface nsIAutoCompletePopup : nsISupports
00044 {
00045   /*
00046    * The input object that the popup is currently bound to
00047    */
00048   readonly attribute nsIAutoCompleteInput input;
00049 
00050   /*
00051    * An alternative value to be used when text is entered, rather than the
00052    * value of the selected item
00053    */
00054   readonly attribute AString overrideValue;
00055 
00056   /*
00057    * The index of the result item that is currently selected
00058    */
00059   attribute long selectedIndex;
00060 
00061   /* 
00062    * Indicates if the popup is currently open
00063    */
00064   readonly attribute boolean popupOpen;
00065 
00066   /* 
00067    * Bind the popup to an input object and display it with the given coordinates
00068    *
00069    * @param input - The input object that the popup will be bound to
00070    * @param x - The x coordinate to display the popup at
00071    * @param y - The y coordinate to display the popup at
00072    * @param width - The width that the popup should size itself to
00073    */
00074   void openPopup(in nsIAutoCompleteInput input, in long x, in long y, in long width);
00075   
00076   /* 
00077    * Close the popup and detach from the bound input
00078    */
00079   void closePopup();
00080 
00081   /*
00082    * Instruct the result view to repaint itself to reflect the most current
00083    * underlying data
00084    */
00085   void invalidate();
00086     
00087   /*
00088    * Change the selection relative to the current selection and make sure
00089    * the newly selected row is visible
00090    *
00091    * @param reverse - Select a row above the current selection
00092    * @param page - Select a row that is a full visible page from the current selection
00093    * @return The currently selected result item index
00094    */
00095   void selectBy(in boolean reverse, in boolean page);
00096 };