widget/src/windows/nsNativeDragTarget.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef _nsNativeDragTarget_h_
  38 #define _nsNativeDragTarget_h_
  39
  40 #include "nsGUIEvent.h"
  41 #include "nsCOMPtr.h"
  42 #include "nsIDragSession.h"
  43 #include <ole2.h>
  44 #include <shlobj.h>
  45
  46 #ifndef WINCE
  47 #ifndef IDropTargetHelper
  48 #ifndef __MINGW32__   // MingW does not provide shobjidl.h.
  49 #include <shobjidl.h> // Vista drag image interfaces
  50 #endif  // MingW
  51 #endif
  52 #endif  // WINCE
  53
  54 class nsIDragService;
  55 class nsIWidget;
  56
  57 struct IDataObject;
  58
  59 /*
  60  * nsNativeDragTarget implements the IDropTarget interface and gets most of its
  61  * behavior from the associated adapter (m_dragDrop).
  62  */
  63
  64 class nsNativeDragTarget : public IDropTarget
  65 {
  66 public:
  67   nsNativeDragTarget(nsIWidget * aWnd);
  68   ~nsNativeDragTarget();
  69
  70   // IUnknown members - see iunknown.h for documentation
  71   STDMETHODIMP QueryInterface(REFIID, void**);
  72   STDMETHODIMP_(ULONG) AddRef();
  73   STDMETHODIMP_(ULONG) Release();
  74
  75   // IDataTarget members
  76
  77   // Set pEffect based on whether this object can support a drop based on
  78   // the data available from pSource, the key and mouse states specified
  79   // in grfKeyState, and the coordinates specified by point. This is
  80   // called by OLE when a drag enters this object's window (as registered
  81   // by Initialize).
  82   STDMETHODIMP DragEnter(LPDATAOBJECT pSource, DWORD grfKeyState,
  83                          POINTL point, DWORD* pEffect);
  84
  85   // Similar to DragEnter except it is called frequently while the drag
  86   // is over this object's window.
  87   STDMETHODIMP DragOver(DWORD grfKeyState, POINTL point, DWORD* pEffect);
  88
  89   // Release the drag-drop source and put internal state back to the point
  90   // before the call to DragEnter. This is called when the drag leaves
  91   // without a drop occurring.
  92   STDMETHODIMP DragLeave();
  93
  94   // If point is within our region of interest and pSource's data supports
  95   // one of our formats, get the data and set pEffect according to
  96   // grfKeyState (DROPEFFECT_MOVE if the control key was not pressed,
  97   // DROPEFFECT_COPY if the control key was pressed). Otherwise return
  98   // E_FAIL.
  99   STDMETHODIMP Drop(LPDATAOBJECT pSource, DWORD grfKeyState,
 100                     POINTL point, DWORD* pEffect);
 101
 102   PRBool           mDragCancelled;
 103
 104 protected:
 105
 106   void GetGeckoDragAction(LPDATAOBJECT pData, DWORD grfKeyState,
 107                           LPDWORD pdwEffect, PRUint32 * aGeckoAction);
 108   void ProcessDrag(LPDATAOBJECT pData, PRUint32 aEventType, DWORD grfKeyState,
 109                    POINTL pt, DWORD* pdwEffect);
 110   void DispatchDragDropEvent(PRUint32 aType, POINTL pt);
 111
 112   // Native Stuff
 113   ULONG            m_cRef;      // reference count
 114   HWND             mHWnd;
 115   PRBool           mCanMove;
 116   PRBool           mMovePreferred;
 117
 118   // Gecko Stuff
 119   nsIWidget      * mWindow;
 120   nsIDragService * mDragService;
 121
 122   // Drag target helper
 123 #ifndef WINCE
 124   IDropTargetHelper * mDropTargetHelper;
 125 #endif
 126 };
 127
 128 #endif // _nsNativeDragTarget_h_
 129
 130