widget/nsIDragSession.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 "nsISupports.idl"
   8 #include "nsITransferable.idl"
   9
  10
  11
  12 %{ C++
  13 #include "nsSize.h"
  14 %}
  15 interface nsIContentSecurityPolicy;
  16
  17 native nsSize(nsSize);
  18
  19 webidl DataTransfer;
  20 webidl WindowContext;
  21 webidl Node;
  22 webidl Selection;
  23
  24 [scriptable, builtinclass, uuid(25bce737-73f0-43c7-bc20-c71044a73c5a)]
  25 interface nsIDragSession : nsISupports
  26 {
  27   /**
  28     * Set the current state of the drag, whether it can be dropped or not.
  29     * usually the target "frame" sets this so the native system can render the correct feedback
  30     */
  31   attribute boolean canDrop;
  32
  33   /**
  34    * Indicates if the drop event should be dispatched only to chrome.
  35    */
  36   attribute boolean onlyChromeDrop;
  37
  38   /**
  39     * Sets the action (copy, move, link, et.c) for the current drag
  40     */
  41   attribute unsigned long dragAction;
  42
  43   /**
  44     * Get the number of items that were dropped
  45     */
  46   readonly attribute unsigned long numDropItems;
  47
  48   /**
  49     * The window context where the drag was started, which will be null if the
  50     * drag originated outside the application. Useful for determining if a drop
  51     * originated in the same window context.
  52     */
  53   [infallible]
  54   attribute WindowContext sourceWindowContext;
  55
  56   /**
  57     * The top-level window context where the drag was started, which will be
  58     * null if the drag originated outside the application. Useful for
  59     * determining if a drop originated in the same top-level window context.
  60     */
  61   [infallible]
  62   attribute WindowContext sourceTopWindowContext;
  63
  64   /**
  65     * The dom node that was originally dragged to start the session, which will be null if the
  66     * drag originated outside the application.
  67     */
  68   readonly attribute Node sourceNode;
  69
  70   /**
  71    * Replace source node and selection with new ones.
  72    * If sourceNode is a native anonymous node, it may be replaced at reframing.
  73    * If sourceNode is disconnected from the document, we cannot dispatch
  74    * `dragend` event properly.
  75    * When this is called, sourceNode or aNewSourceNode should be a native
  76    * anonymous node.
  77    */
  78   [notxpcom, nostdcall] void updateSource(in Node aNewSourceNode,
  79                                           in Selection aNewSelection);
  80
  81   /**
  82    * the triggering principal.  This may be different than sourceNode's
  83    * principal when sourceNode is xul:browser and the drag is
  84    * triggered in a browsing context inside it.
  85    */
  86   attribute nsIPrincipal triggeringPrincipal;
  87
  88   /**
  89    * the triggering csp.  This may be different than sourceNode's
  90    * csp when sourceNode is xul:browser and the drag is
  91    * triggered in a browsing context inside it.
  92    */
  93   attribute nsIContentSecurityPolicy csp;
  94
  95   /**
  96    * The data transfer object for the current drag.
  97    */
  98   [binaryname(DataTransferXPCOM)]
  99   attribute DataTransfer dataTransfer;
 100   [notxpcom, nostdcall] DataTransfer getDataTransfer();
 101   [notxpcom, nostdcall] void setDataTransfer(in DataTransfer aDataTransfer);
 102
 103   /**
 104     * Get data from a Drag&Drop. Can be called while the drag is in process
 105     * or after the drop has completed.
 106     *
 107     * @param  aTransferable the transferable for the data to be put into
 108     * @param  aItemIndex which of multiple drag items, zero-based
 109     */
 110   void getData ( in nsITransferable aTransferable, in unsigned long aItemIndex ) ;
 111
 112    /**
 113     * Check to set if any of the native data on the clipboard matches this data flavor
 114     */
 115   boolean isDataFlavorSupported ( in string aDataFlavor ) ;
 116
 117   void userCancelled();
 118
 119   void dragEventDispatchedToChildProcess();
 120
 121   // Called when nsIDragSession implementation should update the UI for the
 122   // drag-and-drop based on the data got from the child process in response to
 123   // NS_DRAGDROP_OVER sent from parent process to child process.
 124   void updateDragEffect();
 125
 126   // Change the drag image, using similar arguments as
 127   // nsIDragService::InvokeDragSessionWithImage.
 128   void updateDragImage(in Node aImage, in long aImageX, in long aImageY);
 129
 130   /**
 131    * Returns effects allowed at starting the session for tests.
 132    */
 133   [notxpcom, nostdcall] unsigned long getEffectAllowedForTests();
 134
 135   /**
 136    * Returns true if current session was started with synthesized drag start.
 137    */
 138   [notxpcom, nostdcall] bool isSynthesizedForTests();
 139
 140   /**
 141    * Sets drag end point of synthesized session when the test does not dispatch
 142    * "drop" event.
 143    */
 144   void setDragEndPointForTests(in long aScreenX, in long aScreenY);
 145
 146   /**
 147    * Returns true if the session is for dragging text in a text in text control
 148    * element.
 149    */
 150   [notxpcom, nostdcall] bool isDraggingTextInTextControl();
 151 };