content/base/public/nsIDragDropHandler.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 Communicator.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *  Mike Pinkerton <pinkerton@netscape.com>
  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 nsIDOMEventTarget;
  41 interface nsIWebNavigation;
  42
  43
  44 /**
  45  * @status UNDER_REVIEW
  46  */
  47
  48 /**
  49  * Interface for communicating with the built-in drag and drop
  50  * implementation in the content area. Use this to register where
  51  * the listeners should attach (something that implements
  52  * |nsPIDOMEventTarget| which is what we end up using under the hood).
  53  */
  54
  55 [scriptable,uuid(4f418f58-f834-4736-a755-e0395bedca9d)]
  56 interface nsIDragDropHandler : nsISupports
  57 {
  58   /**
  59    * Attach drag handlers to receiver specified by |attachPoint| and
  60    * specify callbacks to allow overriding of the built-in behaviors.
  61    *
  62    * @param attachPoint hookup listeners to this location
  63    * @param navigator loads dropped urls via this interface. If NULL,
  64    *                   the client must handle the drop itself, either
  65    *                   through the method provided via |overrideDrop| or
  66    *                   by letting the event bubble up through the DOM.
  67    */
  68   void hookupTo(in nsIDOMEventTarget attachPoint, in nsIWebNavigation navigator);
  69
  70   /**
  71    * Unregister all handlers related to drag&drop
  72    */
  73   void detach();
  74 };