add back ghost/guardedalloc from trunk
[blender-staging.git] / intern / ghost / intern / GHOST_DropTargetWin32.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file ghost/intern/GHOST_DropTargetWin32.h
30  *  \ingroup GHOST
31  */
32
33 #ifndef _GHOST_DROP_TARGET_WIN32_H_
34 #define _GHOST_DROP_TARGET_WIN32_H_
35
36 #include <windows.h>
37 #include <string.h>
38 #include <GHOST_Types.h>
39 #include "GHOST_WindowWin32.h"
40 #include "GHOST_SystemWin32.h"
41
42 class GHOST_DropTargetWin32 : public IDropTarget
43 {
44 public:
45         /* IUnknownd implementation.
46          * Enables clients to get pointers to other interfaces on a given object 
47          * through the QueryInterface method, and manage the existence of the object
48          * through the AddRef and Release methods. All other COM interfaces are 
49          * inherited, directly or indirectly, from IUnknown. Therefore, the three 
50          * methods in IUnknown are the first entries in the VTable for every interface. 
51          */
52         HRESULT __stdcall QueryInterface (REFIID riid, void ** ppvObj);
53         ULONG   __stdcall AddRef (void);
54         ULONG   __stdcall Release (void);
55
56         /* IDropTarget implementation
57          + The IDropTarget interface is one of the interfaces you implement to 
58          provide drag-and-drop operations in your application. It contains methods 
59          used in any application that can be a target for data during a 
60          drag-and-drop operation. A drop-target application is responsible for:
61          * 
62          *      - Determining the effect of the drop on the target application.
63          *      - Incorporating any valid dropped data when the drop occurs.
64          *      - Communicating target feedback to the source so the source application
65          *        can provide appropriate visual feedback such as setting the cursor.
66          *      - Implementing drag scrolling.
67          *      - Registering and revoking its application windows as drop targets.
68          * 
69          * The IDropTarget interface contains methods that handle all these 
70          * responsibilities except registering and revoking the application window 
71          * as a drop target, for which you must call the RegisterDragDrop and the 
72          * RevokeDragDrop functions.
73          */
74         
75         HRESULT __stdcall DragEnter (IDataObject * pDataObject, DWORD grfKeyState, POINTL pt, DWORD * pdwEffect);
76         HRESULT __stdcall DragOver (DWORD grfKeyState, POINTL pt, DWORD * pdwEffect);
77         HRESULT __stdcall DragLeave (void);
78         HRESULT __stdcall Drop (IDataObject * pDataObject, DWORD grfKeyState, POINTL pt, DWORD * pdwEffect);
79
80         /**
81          * Constructor
82          * With the modifier keys, we want to distinguish left and right keys.
83          * Sometimes this is not possible (Windows ME for instance). Then, we want
84          * events generated for both keys.
85          * @param window        The window to register as drop target.
86          * @param system        The associated system.
87          */
88         GHOST_DropTargetWin32(GHOST_WindowWin32 * window, GHOST_SystemWin32 * system);
89
90         /**
91          * Destructor
92          * Do NOT destroy directly. Use Release() instead to make COM happy.
93          */
94         ~GHOST_DropTargetWin32();
95
96 private:
97
98         /* Internal helper functions */
99
100         /**
101          * Base the effect on those allowed by the dropsource.
102          * @param dwAllowed Drop sources allowed drop effect.
103          * @return The allowed drop effect.
104          */
105         DWORD allowedDropEffect(DWORD dwAllowed);
106
107         /**
108          * Query DataObject for the data types it supports.
109          * @param pDataObject Pointer to the DataObject.
110          * @return GHOST data type.
111          */
112         GHOST_TDragnDropTypes getGhostType(IDataObject * pDataObject);
113
114         /**
115          * Get data to pass in event.
116          * It checks the type and calls specific functions for each type.
117          * @param pDataObject Pointer to the DataObject.
118          * @return Pointer to data.
119          */
120         void * getGhostData(IDataObject * pDataObject);
121
122         /**
123          * Allocate data as file array to pass in event.
124          * @param pDataObject Pointer to the DataObject.
125          * @return Pointer to data.
126          */
127         void * getDropDataAsFilenames(IDataObject * pDataObject);
128
129         /**
130          * Allocate data as string to pass in event.
131          * @param pDataObject Pointer to the DataObject.
132          * @return Pointer to data.
133          */
134         void * getDropDataAsString(IDataObject * pDataObject);
135
136         /**
137          * Convert Unicode to ANSI, replacing unconvertable chars with '?'.
138          * The ANSI codepage is the system default codepage, 
139          * and can change from system to system.
140          * @param in LPCWSTR.
141          * @param out char *. Is set to NULL on failure.
142          * @return 0 on failure. Else the size of the string including '\0'.
143          */
144         int WideCharToANSI(LPCWSTR in, char * &out);
145
146         /* Private member variables */
147         /* COM reference count. */
148         LONG    m_cRef; 
149         /* Handle of the associated window. */
150         HWND    m_hWnd;
151         /* The associated GHOST_WindowWin32. */
152         GHOST_WindowWin32 * m_window;
153         /* The System. */
154         GHOST_SystemWin32 * m_system;
155         /* Data type of the dragged object */
156         GHOST_TDragnDropTypes m_draggedObjectType;
157
158 };
159
160 #endif  // _GHOST_DROP_TARGET_WIN32_H_