merged 29285:30707 from trunk
[blender.git] / intern / ghost / intern / GHOST_EventDragnDrop.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): Damien Plisson 11/2009
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef _GHOST_EVENT_DRAGNDROP_H_
30 #define _GHOST_EVENT_DRAGNDROP_H_
31
32 #include "GHOST_Event.h"
33 extern "C" {
34 #include "IMB_imbuf.h"
35 #include "IMB_imbuf_types.h"
36 };
37
38 /**
39  * Drag & drop event
40  * 
41  * The dragging sequence is performed in four phases:
42  * 
43  * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started. Already gives the object data type,
44  * and the entering mouse location
45  *
46  * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation stops, to give the updated mouse position.
47  * Useful to highlight a potential destination, and update the status (through GHOST_setAcceptDragOperation) telling if the object can be dropped at
48  * the current cursor position.
49  *
50  * <li> Abort drag'n'drop sequence (GHOST_kEventDraggingExited) sent when the user moved the mouse outside the window.
51  *
52  * <li> Send the dropped data (GHOST_kEventDraggingDropDone)
53  *
54  * <li> Outside of the normal sequence, dropped data can be sent (GHOST_kEventDraggingDropOnIcon). This can happen when the user drops an object
55  * on the application icon. (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
56  *
57  * <br><br>Note that the mouse positions are given in Blender coordinates (y=0 at bottom)
58  *
59  * <br>Currently supported object types :
60  * <li>UTF-8 string
61  * <li>array of strings representing filenames (GHOST_TStringArray)
62  * <li>bitmap ImBuf
63  */
64 class GHOST_EventDragnDrop : public GHOST_Event
65 {
66 public:
67         /**
68          * Constructor.
69          * @param time          The time this event was generated.
70          * @param type          The type of this event.
71          * @param dataType      The type of the drop candidate object
72          * @param window        The window where the event occurred
73          * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
74          * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
75          * @param data          The "content" dropped in the window
76          */
77         GHOST_EventDragnDrop(GHOST_TUns64 time, GHOST_TEventType type, GHOST_TDragnDropTypes dataType, GHOST_IWindow* window,
78                                                  int x, int y, GHOST_TEventDataPtr data)
79                 : GHOST_Event(time, type, window)
80         {
81                 m_dragnDropEventData.x = x;
82                 m_dragnDropEventData.y = y;
83                 m_dragnDropEventData.dataType = dataType;
84                 m_dragnDropEventData.data = data;
85                 m_data = &m_dragnDropEventData;
86         }
87         
88         ~GHOST_EventDragnDrop()
89         {
90                 //Free the dropped object data
91                 if (m_dragnDropEventData.data == NULL)
92                         return;
93                 
94                 switch (m_dragnDropEventData.dataType) {
95                         case GHOST_kDragnDropTypeBitmap:
96                                 IMB_freeImBuf((ImBuf*)m_dragnDropEventData.data);
97                                 break;
98                         case GHOST_kDragnDropTypeFilenames:
99                         {
100                                 GHOST_TStringArray *strArray = (GHOST_TStringArray*)m_dragnDropEventData.data;
101                                 int i;
102                                 
103                                 for (i=0;i<strArray->count;i++)
104                                         free(strArray->strings[i]);
105                                 
106                                 free(strArray);
107                         }
108                                 break;
109                         case GHOST_kDragnDropTypeString:
110                                 free(m_dragnDropEventData.data);
111                         break;
112
113                         default:
114                                 break;
115                 }
116         }
117         
118         
119
120 protected:
121         /** The x,y-coordinates of the cursor position. */
122         GHOST_TEventDragnDropData m_dragnDropEventData;
123 };
124
125 #endif // _GHOST_EVENT_DRAGNDROP_H_
126