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