toolkit/components/satchel/public/nsIFormFillController.idl

   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 nsIDocShell;
  41 interface nsIAutoCompletePopup;
  42 interface nsIDOMHTMLInputElement;
  43
  44 /*
  45  * nsIFormFillController is an interface for controlling form fill behavior
  46  * on HTML documents.  Any number of docShells can be controller concurrently.
  47  * While a docShell is attached, all HTML documents that are loaded within it
  48  * will have a focus listener attached that will listen for when a text input
  49  * is focused.  When this happens, the input will be bound to the
  50  * global nsIAutoCompleteController service.
  51  */
  52
  53 [scriptable, uuid(07f0a0dc-f6e9-4cdd-a55f-56d770523a4c)]
  54 interface nsIFormFillController : nsISupports
  55 {
  56   /*
  57    * Start controlling form fill behavior for the given browser
  58    *
  59    * @param docShell - The docShell to attach to
  60    * @param popup - The popup to show when autocomplete results are available
  61    */
  62   void attachToBrowser(in nsIDocShell docShell, in nsIAutoCompletePopup popup);
  63
  64   /*
  65    * Stop controlling form fill behavior for the given browser
  66    *
  67    * @param docShell - The docShell to detach from
  68    */
  69   void detachFromBrowser(in nsIDocShell docShell);
  70
  71   /*
  72    * Mark the specified <input> element as being managed by password manager.
  73    * Autocomplete requests will be handed off to the password manager, and will
  74    * not be stored in form history.
  75    *
  76    * @param aInput - The HTML <input> element to tag
  77    */
  78   void markAsLoginManagerField(in nsIDOMHTMLInputElement aInput);
  79 };