widget/nsIDragService.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsIArray.idl"
   8 #include "nsISupports.idl"
   9 #include "nsIDragSession.idl"
  10 #include "nsIContentPolicy.idl"
  11
  12 webidl DragEvent;
  13 webidl Node;
  14 webidl Selection;
  15
  16 %{C++
  17 #include "mozilla/EventForwards.h"
  18
  19 namespace mozilla {
  20 namespace dom {
  21 class ContentParent;
  22 class DataTransfer;
  23 class RemoteDragStartData;
  24 } // namespace dom
  25 } // namespace mozilla
  26 %}
  27
  28 [ptr] native ContentParentPtr(mozilla::dom::ContentParent);
  29 [ptr] native DataTransferPtr(mozilla::dom::DataTransfer);
  30 [ptr] native RemoteDragStartDataPtr(mozilla::dom::RemoteDragStartData);
  31 native EventMessage(mozilla::EventMessage);
  32
  33 [scriptable, uuid(ebd6b3a2-af16-43af-a698-3091a087dd62), builtinclass]
  34 interface nsIDragService : nsISupports
  35 {
  36   const long DRAGDROP_ACTION_NONE = 0;
  37   const long DRAGDROP_ACTION_COPY = 1;
  38   const long DRAGDROP_ACTION_MOVE = 2;
  39   const long DRAGDROP_ACTION_LINK = 4;
  40   const long DRAGDROP_ACTION_UNINITIALIZED = 64;
  41
  42   /**
  43     * Starts a modal drag session with an array of transaferables.
  44     *
  45     * Note: This method is deprecated for non-native code.
  46     *
  47     * @param  aPrincipal - the triggering principal of the drag, or null if
  48     *                      it's from browser chrome or OS
  49     * @param  aTransferables - an array of transferables to be dragged
  50     * @param  aActionType - specified which of copy/move/link are allowed
  51     * @param  aContentPolicyType - the contentPolicyType that will be
  52     *           passed to the loadInfo when creating a new channel
  53     *           (defaults to TYPE_OTHER)
  54     */
  55   [can_run_script]
  56   void invokeDragSession (in Node aDOMNode,
  57                           in nsIPrincipal aPrincipal,
  58                           in nsIArray aTransferables,
  59                           in unsigned long aActionType,
  60                           [optional] in nsContentPolicyType aContentPolicyType);
  61
  62   /**
  63    * Starts a modal drag session using an image. The first four arguments are
  64    * the same as invokeDragSession.
  65    *
  66    * Note: This method is deprecated for non-native code.
  67    *
  68    * A custom image may be specified using the aImage argument. If this is
  69    * supplied, the aImageX and aImageY arguments specify the offset within
  70    * the image where the cursor would be positioned. That is, when the image
  71    * is drawn, it is offset up and left the amount so that the cursor appears
  72    * at that location within the image.
  73    *
  74    * If aImage is null, aImageX and aImageY are not used and the image is instead
  75    * determined from the source node aDOMNode, and the offset calculated so that
  76    * the initial location for the image appears in the same screen position as
  77    * where the element is located. The node must be within a document.
  78    *
  79    * Currently, supported images are all DOM nodes. If this is an HTML <image> or
  80    * <canvas>, the drag image is taken from the image data. If the element is in
  81    * a document, it will be rendered at its displayed size, othewise, it will be
  82    * rendered at its real size. For other types of elements, the element is
  83    * rendered into an offscreen buffer in the same manner as it is currently
  84    * displayed. The document selection is hidden while drawing.
  85    *
  86    * The aDragEvent must be supplied as the current screen coordinates of the
  87    * event are needed to calculate the image location.
  88    */
  89   [noscript, can_run_script]
  90   void invokeDragSessionWithImage(in Node aDOMNode,
  91                                   in nsIPrincipal aPrincipal,
  92                                   in nsIArray aTransferableArray,
  93                                   in unsigned long aActionType,
  94                                   in Node aImage,
  95                                   in long aImageX,
  96                                   in long aImageY,
  97                                   in DragEvent aDragEvent,
  98                                   in DataTransferPtr aDataTransfer);
  99
 100   /** Start a drag session with the data in aDragStartData from a child process.
 101    *  Other arguments are the same as invokeDragSessionWithImage.
 102    */
 103   [noscript, can_run_script]
 104   void invokeDragSessionWithRemoteImage(in Node aDOMNode,
 105                                         in nsIPrincipal aPrincipal,
 106                                         in nsIArray aTransferableArray,
 107                                         in unsigned long aActionType,
 108                                         in RemoteDragStartDataPtr aDragStartData,
 109                                         in DragEvent aDragEvent,
 110                                         in DataTransferPtr aDataTransfer);
 111
 112   /**
 113    * Start a modal drag session using the selection as the drag image.
 114    * The aDragEvent must be supplied as the current screen coordinates of the
 115    * event are needed to calculate the image location.
 116    *
 117    * Note: This method is deprecated for non-native code.
 118    */
 119   [can_run_script]
 120   void invokeDragSessionWithSelection(in Selection aSelection,
 121                                       in nsIPrincipal aPrincipal,
 122                                       in nsIArray aTransferableArray,
 123                                       in unsigned long aActionType,
 124                                       in DragEvent aDragEvent,
 125                                       in DataTransferPtr aDataTransfer);
 126
 127   /**
 128     * Returns the current Drag Session
 129     */
 130   nsIDragSession getCurrentSession();
 131
 132   /**
 133     * Tells the Drag Service to start a drag session. This is called when
 134     * an external drag occurs
 135     */
 136   void startDragSession ( ) ;
 137
 138   /**
 139     * Tells the Drag Service to end a drag session. This is called when
 140     * an external drag occurs
 141     *
 142     * If aDoneDrag is true, the drag has finished, otherwise the drag has
 143     * just left the window.
 144     */
 145   [can_run_script]
 146   void endDragSession(in boolean aDoneDrag,
 147                       [optional] in unsigned long aKeyModifiers);
 148
 149   /**
 150    * Fire a drag event at the source of the drag
 151    */
 152   [noscript, can_run_script]
 153   void fireDragEventAtSource(in EventMessage aEventMessage,
 154                              in unsigned long aKeyModifiers);
 155
 156   /**
 157    * Increase/decrease dragging suppress level by one.
 158    * If level is greater than one, dragging is disabled.
 159    */
 160   [can_run_script]
 161   void suppress();
 162   void unsuppress();
 163
 164   /**
 165     * aX and aY are in LayoutDevice pixels.
 166     */
 167   [noscript] void dragMoved(in long aX, in long aY);
 168
 169   [notxpcom, nostdcall] boolean maybeAddChildProcess(in ContentParentPtr aChild);
 170 };
 171
 172
 173 %{ C++
 174
 175 %}