Merged changes in the trunk up to revision 41368.
[blender.git] / intern / ghost / intern / GHOST_EventDragnDrop.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Damien Plisson 11/2009
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_EventDragnDrop.h
29  *  \ingroup GHOST
30  */
31
32
33 #ifndef _GHOST_EVENT_DRAGNDROP_H_
34 #define _GHOST_EVENT_DRAGNDROP_H_
35
36 #include "GHOST_Event.h"
37 extern "C" {
38 #include "IMB_imbuf.h"
39 #include "IMB_imbuf_types.h"
40 };
41
42 /**
43  * Drag & drop event
44  * 
45  * The dragging sequence is performed in four phases:
46  * 
47  * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started. Already gives the object data type,
48  * and the entering mouse location
49  *
50  * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation stops, to give the updated mouse position.
51  * Useful to highlight a potential destination, and update the status (through GHOST_setAcceptDragOperation) telling if the object can be dropped at
52  * the current cursor position.
53  *
54  * <li> Abort drag'n'drop sequence (GHOST_kEventDraggingExited) sent when the user moved the mouse outside the window.
55  *
56  * <li> Send the dropped data (GHOST_kEventDraggingDropDone)
57  *
58  * <li> Outside of the normal sequence, dropped data can be sent (GHOST_kEventDraggingDropOnIcon). This can happen when the user drops an object
59  * on the application icon. (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
60  *
61  * <br><br>Note that the mouse positions are given in Blender coordinates (y=0 at bottom)
62  *
63  * <br>Currently supported object types :
64  * <li>UTF-8 string
65  * <li>array of strings representing filenames (GHOST_TStringArray)
66  * <li>bitmap ImBuf
67  */
68 class GHOST_EventDragnDrop : public GHOST_Event
69 {
70 public:
71         /**
72          * Constructor.
73          * @param time          The time this event was generated.
74          * @param type          The type of this event.
75          * @param dataType      The type of the drop candidate object
76          * @param window        The window where the event occurred
77          * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
78          * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
79          * @param data          The "content" dropped in the window
80          */
81         GHOST_EventDragnDrop(GHOST_TUns64 time, GHOST_TEventType type, GHOST_TDragnDropTypes dataType, GHOST_IWindow* window,
82                                                  int x, int y, GHOST_TEventDataPtr data)
83                 : GHOST_Event(time, type, window)
84         {
85                 m_dragnDropEventData.x = x;
86                 m_dragnDropEventData.y = y;
87                 m_dragnDropEventData.dataType = dataType;
88                 m_dragnDropEventData.data = data;
89                 m_data = &m_dragnDropEventData;
90         }
91         
92         ~GHOST_EventDragnDrop()
93         {
94                 //Free the dropped object data
95                 if (m_dragnDropEventData.data == NULL)
96                         return;
97                 
98                 switch (m_dragnDropEventData.dataType) {
99                         case GHOST_kDragnDropTypeBitmap:
100                                 IMB_freeImBuf((ImBuf*)m_dragnDropEventData.data);
101                                 break;
102                         case GHOST_kDragnDropTypeFilenames:
103                         {
104                                 GHOST_TStringArray *strArray = (GHOST_TStringArray*)m_dragnDropEventData.data;
105                                 int i;
106                                 
107                                 for (i=0;i<strArray->count;i++)
108                                         free(strArray->strings[i]);
109                                 
110                                 free(strArray);
111                         }
112                                 break;
113                         case GHOST_kDragnDropTypeString:
114                                 free(m_dragnDropEventData.data);
115                         break;
116
117                         default:
118                                 break;
119                 }
120         }
121         
122         
123
124 protected:
125         /** The x,y-coordinates of the cursor position. */
126         GHOST_TEventDragnDropData m_dragnDropEventData;
127 };
128
129 #endif // _GHOST_EVENT_DRAGNDROP_H_
130