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 %{ C++
  12 #include "nsSize.h"
  13 %}
  14
  15 native nsSize (nsSize);
  16
  17 webidl DataTransfer;
  18 webidl Document;
  19 webidl Node;
  20
  21 [scriptable, builtinclass, uuid(25bce737-73f0-43c7-bc20-c71044a73c5a)]
  22 interface nsIDragSession : nsISupports
  23 {
  24   /**
  25     * Set the current state of the drag, whether it can be dropped or not.
  26     * usually the target "frame" sets this so the native system can render the correct feedback
  27     */
  28   attribute boolean canDrop;
  29
  30   /**
  31    * Indicates if the drop event should be dispatched only to chrome.
  32    */
  33   attribute boolean onlyChromeDrop;
  34
  35   /**
  36     * Sets the action (copy, move, link, et.c) for the current drag
  37     */
  38   attribute unsigned long dragAction;
  39
  40   /**
  41     * Get the number of items that were dropped
  42     */
  43   readonly attribute unsigned long numDropItems;
  44
  45   /**
  46     * The document where the drag was started, which will be null if the
  47     * drag originated outside the application. Useful for determining if a drop
  48     * originated in the same document.
  49     */
  50   readonly attribute Document sourceDocument;
  51
  52   /**
  53     * The dom node that was originally dragged to start the session, which will be null if the
  54     * drag originated outside the application.
  55     */
  56   readonly attribute Node sourceNode;
  57
  58   /**
  59    * the triggering principal.  This may be different than sourceNode's
  60    * principal when sourceNode is xul:browser and the drag is
  61    * triggered in a browsing context inside it.
  62    */
  63   attribute nsIPrincipal triggeringPrincipal;
  64
  65   /**
  66    * The data transfer object for the current drag.
  67    */
  68   [binaryname(DataTransferXPCOM)]
  69   attribute DataTransfer dataTransfer;
  70   [notxpcom, nostdcall] DataTransfer getDataTransfer();
  71   [notxpcom, nostdcall] void setDataTransfer(in DataTransfer aDataTransfer);
  72
  73   /**
  74     * Get data from a Drag&Drop. Can be called while the drag is in process
  75     * or after the drop has completed.
  76     *
  77     * @param  aTransferable the transferable for the data to be put into
  78     * @param  aItemIndex which of multiple drag items, zero-based
  79     */
  80   void getData ( in nsITransferable aTransferable, in unsigned long aItemIndex ) ;
  81
  82    /**
  83     * Check to set if any of the native data on the clipboard matches this data flavor
  84     */
  85   boolean isDataFlavorSupported ( in string aDataFlavor ) ;
  86
  87   void userCancelled();
  88
  89   void dragEventDispatchedToChildProcess();
  90
  91   // Called when nsIDragSession implementation should update the UI for the
  92   // drag-and-drop based on the data got from the child process in response to
  93   // NS_DRAGDROP_OVER sent from parent process to child process.
  94   void updateDragEffect();
  95
  96   // Change the drag image, using similar arguments as
  97   // nsIDragService::InvokeDragSessionWithImage.
  98   void updateDragImage(in Node aImage, in long aImageX, in long aImageY);
  99 };
 100
 101
 102 %{ C++
 103
 104 %}