Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_EventDragnDrop.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 \ingroup GHOST
21  */
22
23
24 #ifndef __GHOST_EVENTDRAGNDROP_H__
25 #define __GHOST_EVENTDRAGNDROP_H__
26
27 #include "GHOST_Event.h"
28 extern "C" {
29 #include "IMB_imbuf.h"
30 #include "IMB_imbuf_types.h"
31 };
32
33 /**
34  * Drag & drop event
35  *
36  * The dragging sequence is performed in four phases:
37  *
38  * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started.
39  * Already gives the object data type, and the entering mouse location
40  *
41  * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation
42  * stops, to give the updated mouse position. Useful to highlight a potential destination, and update the status
43  * (through GHOST_setAcceptDragOperation) telling if the object can be dropped at
44  * the current cursor position.
45  *
46  * <li> Abort drag'n'drop sequence (GHOST_kEventDraggingExited) sent when the user moved the mouse outside the window.
47  *
48  * <li> Send the dropped data (GHOST_kEventDraggingDropDone)
49  *
50  * <li> Outside of the normal sequence, dropped data can be sent (GHOST_kEventDraggingDropOnIcon).
51  * This can happen when the user drops an object on the application icon.
52  * (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
53  *
54  * <br><br>Note that the mouse positions are given in Blender coordinates (y=0 at bottom)
55  *
56  * <br>Currently supported object types :
57  * <li>UTF-8 string
58  * <li>array of strings representing filenames (GHOST_TStringArray)
59  * <li>bitmap ImBuf
60  */
61 class GHOST_EventDragnDrop : public GHOST_Event
62 {
63 public:
64         /**
65          * Constructor.
66          * \param time      The time this event was generated.
67          * \param type      The type of this event.
68          * \param dataType  The type of the drop candidate object
69          * \param window    The window where the event occurred
70          * \param x         The x-coordinate of the location the cursor was at at the time of the event.
71          * \param y         The y-coordinate of the location the cursor was at at the time of the event.
72          * \param data      The "content" dropped in the window
73          */
74         GHOST_EventDragnDrop(GHOST_TUns64 time,
75                              GHOST_TEventType type,
76                              GHOST_TDragnDropTypes dataType,
77                              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->strings);
107                                 free(strArray);
108                         }
109                         break;
110                         case GHOST_kDragnDropTypeString:
111                                 free(m_dragnDropEventData.data);
112                                 break;
113
114                         default:
115                                 break;
116                 }
117         }
118
119
120
121 protected:
122         /** The x,y-coordinates of the cursor position. */
123         GHOST_TEventDragnDropData m_dragnDropEventData;
124 };
125
126 #endif // __GHOST_EVENTDRAGNDROP_H__