gecko-dev/content/base/public/nsIDragDropHandler.idl
2003-04-17 19:42:27 +00:00

75 lines
2.8 KiB
Plaintext

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Mozilla Communicator.
*
* The Initial Developer of the Original Code is
* Netscape Communications.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Mike Pinkerton <pinkerton@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIDOMEventTarget;
interface nsIWebNavigation;
/**
* @status UNDER_REVIEW
*/
/**
* Interface for communicating with the built-in drag and drop
* implementation in the content area. Use this to register where
* the listeners should attach (something that implements
* |nsIDOMEventReceiver| which is what we end up using under the hood).
*/
[scriptable,uuid(4f418f58-f834-4736-a755-e0395bedca9d)]
interface nsIDragDropHandler : nsISupports
{
/**
* Attach drag handlers to receiver specified by |attachPoint| and
* specify callbacks to allow overriding of the built-in behaviors.
*
* @param attachPoint hookup listeners to this location
* @param navigator loads dropped urls via this interface. If NULL,
* the client must handle the drop itself, either
* through the method provided via |overrideDrop| or
* by letting the event bubble up through the DOM.
*/
void hookupTo(in nsIDOMEventTarget attachPoint, in nsIWebNavigation navigator);
/**
* Unregister all handlers related to drag&drop
*/
void detach();
};