Back to index

lightning-sunbird  0.9+nobinonly
nsIFormFillController.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 nsIDocShell;
00041 interface nsIAutoCompletePopup;
00042 
00043 /*
00044  * nsIFormFillController is an interface for controlling form fill behavior
00045  * on HTML documents.  Any number of docShells can be controller concurrently.
00046  * While a docShell is attached, all HTML documents that are loaded within it
00047  * will have a focus listener attached that will listen for when a text input
00048  * is focused.  When this happens, the input will be bound to the
00049  * global nsIAutoCompleteController service.
00050  */
00051 
00052 [scriptable, uuid(872F07F3-ED11-47c6-B7CF-246DB53379FB)]
00053 interface nsIFormFillController : nsISupports
00054 {
00055   /*
00056    * Start controlling form fill behavior for the given browser
00057    *
00058    * @param docShell - The docShell to attach to
00059    * @param popup - The popup to show when autocomplete results are available
00060    */
00061   void attachToBrowser(in nsIDocShell docShell, in nsIAutoCompletePopup popup);
00062   
00063   /*
00064    * Stop controlling form fill behavior for the given browser
00065    *
00066    * @param docShell - The docShell to detach from
00067    */
00068   void detachFromBrowser(in nsIDocShell docShell);
00069 };