widget/public/nsIClipboardDragDropHookList.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) 2003
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *  Kathleen Brade <brade@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 nsIClipboardDragDropHooks;
  41 interface nsISimpleEnumerator;
  42
  43
  44 /**
  45  * Please note that the following api is not intended for embedders;
  46  * it is intended as an internal (to gecko).  Embedders can indirectly
  47  * call these by sending commands (see description in
  48  * nsIClipboardDragDropHooks.idl).
  49  *
  50  * Internal gecko usage is accomplished by calling get_Interface on a
  51  * docshell.
  52  */
  53
  54
  55 // 876A2015-6B66-11D7-8F18-0003938A9D96
  56 [scriptable,uuid(876A2015-6B66-11D7-8F18-0003938A9D96)]
  57 interface nsIClipboardDragDropHookList : nsISupports
  58 {
  59   /**
  60    * Add a hook to list.
  61    * @param aHooks  implementation of hooks
  62    */
  63   void addClipboardDragDropHooks(in nsIClipboardDragDropHooks aHooks);
  64
  65   /**
  66    * Remove a hook from list (note if this implementation is not present
  67    * in the list then removal will be ignored).
  68    * @param aHooks  implementation of hooks
  69    */
  70   void removeClipboardDragDropHooks(in nsIClipboardDragDropHooks aHooks);
  71
  72   /**
  73    * Gets an enumerator for all hooks which have been added.
  74    * @return nsISimpleEnumerator for nsIClipboardDragDropHooks
  75    */
  76   nsISimpleEnumerator getHookEnumerator();
  77 };
  78