widget/public/nsIDragSession.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corp.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Mike Pinkerton
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsISupportsArray.idl"
  42 #include "nsITransferable.idl"
  43
  44
  45 %{ C++
  46 #include "nsSize.h"
  47 %}
  48
  49 native nsSize (nsSize);
  50
  51
  52 interface nsIDOMDocument;
  53 interface nsIDOMNode;
  54 interface nsIDOMDataTransfer;
  55
  56 [scriptable, uuid(fde41f6a-c710-46f8-a0a8-1ff76ca4ff57)]
  57 interface nsIDragSession : nsISupports
  58 {
  59   /**
  60     * Set the current state of the drag, whether it can be dropped or not.
  61     * usually the target "frame" sets this so the native system can render the correct feedback
  62     */
  63   attribute boolean canDrop;
  64
  65   /**
  66    * Indicates if the drop event should be dispatched only to chrome.
  67    */
  68   attribute boolean onlyChromeDrop;
  69
  70   /**
  71     * Sets the action (copy, move, link, et.c) for the current drag
  72     */
  73   attribute unsigned long dragAction;
  74
  75   /**
  76     * Sets the current width and height of the drag target area.
  77     * It will contain the current size of the Frame that the drag is currently in
  78     */
  79   [noscript] attribute nsSize targetSize;
  80
  81   /**
  82     * Get the number of items that were dropped
  83     */
  84   readonly attribute unsigned long numDropItems;
  85
  86   /**
  87     * The document where the drag was started, which will be null if the
  88     * drag originated outside the application. Useful for determining if a drop
  89     * originated in the same document.
  90     */
  91   readonly attribute nsIDOMDocument sourceDocument;
  92
  93   /**
  94     * The dom node that was originally dragged to start the session, which will be null if the
  95     * drag originated outside the application.
  96     */
  97   readonly attribute nsIDOMNode sourceNode;
  98
  99   /**
 100    * The data transfer object for the current drag.
 101    */
 102   attribute nsIDOMDataTransfer dataTransfer;
 103
 104   /**
 105     * Get data from a Drag&Drop. Can be called while the drag is in process
 106     * or after the drop has completed.
 107     *
 108     * @param  aTransferable the transferable for the data to be put into
 109     * @param  aItemIndex which of multiple drag items, zero-based
 110     */
 111   void getData ( in nsITransferable aTransferable, in unsigned long aItemIndex ) ;
 112
 113    /**
 114     * Check to set if any of the native data on the clipboard matches this data flavor
 115     */
 116   boolean isDataFlavorSupported ( in string aDataFlavor ) ;
 117
 118 };
 119
 120
 121 %{ C++
 122
 123 %}