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