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 dom node that was originally dragged to start the session, which will be null if the
  58     * drag originated outside the application.
  59     */
  60   readonly attribute Node sourceNode;
  61
  62   /**
  63    * Replace source node and selection with new ones.
  64    * If sourceNode is a native anonymous node, it may be replaced at reframing.
  65    * If sourceNode is disconnected from the document, we cannot dispatch
  66    * `dragend` event properly.
  67    * When this is called, sourceNode or aNewSourceNode should be a native
  68    * anonymous node.
  69    */
  70   [notxpcom, nostdcall] void updateSource(in Node aNewSourceNode,
  71                                           in Selection aNewSelection);
  72
  73   /**
  74    * the triggering principal.  This may be different than sourceNode's
  75    * principal when sourceNode is xul:browser and the drag is
  76    * triggered in a browsing context inside it.
  77    */
  78   attribute nsIPrincipal triggeringPrincipal;
  79
  80   /**
  81    * the triggering csp.  This may be different than sourceNode's
  82    * csp when sourceNode is xul:browser and the drag is
  83    * triggered in a browsing context inside it.
  84    */
  85   attribute nsIContentSecurityPolicy csp;
  86
  87   /**
  88    * The data transfer object for the current drag.
  89    */
  90   [binaryname(DataTransferXPCOM)]
  91   attribute DataTransfer dataTransfer;
  92   [notxpcom, nostdcall] DataTransfer getDataTransfer();
  93   [notxpcom, nostdcall] void setDataTransfer(in DataTransfer aDataTransfer);
  94
  95   /**
  96     * Get data from a Drag&Drop. Can be called while the drag is in process
  97     * or after the drop has completed.
  98     *
  99     * @param  aTransferable the transferable for the data to be put into
 100     * @param  aItemIndex which of multiple drag items, zero-based
 101     */
 102   void getData ( in nsITransferable aTransferable, in unsigned long aItemIndex ) ;
 103
 104    /**
 105     * Check to set if any of the native data on the clipboard matches this data flavor
 106     */
 107   boolean isDataFlavorSupported ( in string aDataFlavor ) ;
 108
 109   void userCancelled();
 110
 111   void dragEventDispatchedToChildProcess();
 112
 113   // Called when nsIDragSession implementation should update the UI for the
 114   // drag-and-drop based on the data got from the child process in response to
 115   // NS_DRAGDROP_OVER sent from parent process to child process.
 116   void updateDragEffect();
 117
 118   // Change the drag image, using similar arguments as
 119   // nsIDragService::InvokeDragSessionWithImage.
 120   void updateDragImage(in Node aImage, in long aImageX, in long aImageY);
 121
 122   /**
 123    * Returns effects allowed at starting the session for tests.
 124    */
 125   [notxpcom, nostdcall] unsigned long getEffectAllowedForTests();
 126
 127   /**
 128    * Returns true if current session was started with synthesized drag start.
 129    */
 130   [notxpcom, nostdcall] bool isSynthesizedForTests();
 131
 132   /**
 133    * Sets drag end point of synthesized session when the test does not dispatch
 134    * "drop" event.
 135    */
 136   void setDragEndPointForTests(in long aScreenX, in long aScreenY);
 137
 138   /**
 139    * Returns true if the session is for dragging text in a text in text control
 140    * element.
 141    */
 142   [notxpcom, nostdcall] bool isDraggingTextInTextControl();
 143 };