ClangFormat: apply to source, most of intern
[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
21  * \ingroup GHOST
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  public:
63   /**
64    * Constructor.
65    * \param time      The time this event was generated.
66    * \param type      The type of this event.
67    * \param dataType  The type of the drop candidate object
68    * \param window    The window where the event occurred
69    * \param x         The x-coordinate of the location the cursor was at at the time of the event.
70    * \param y         The y-coordinate of the location the cursor was at at the time of the event.
71    * \param data      The "content" dropped in the window
72    */
73   GHOST_EventDragnDrop(GHOST_TUns64 time,
74                        GHOST_TEventType type,
75                        GHOST_TDragnDropTypes dataType,
76                        GHOST_IWindow *window,
77                        int x,
78                        int y,
79                        GHOST_TEventDataPtr data)
80       : GHOST_Event(time, type, window)
81   {
82     m_dragnDropEventData.x = x;
83     m_dragnDropEventData.y = y;
84     m_dragnDropEventData.dataType = dataType;
85     m_dragnDropEventData.data = data;
86     m_data = &m_dragnDropEventData;
87   }
88
89   ~GHOST_EventDragnDrop()
90   {
91     //Free the dropped object data
92     if (m_dragnDropEventData.data == NULL)
93       return;
94
95     switch (m_dragnDropEventData.dataType) {
96       case GHOST_kDragnDropTypeBitmap:
97         IMB_freeImBuf((ImBuf *)m_dragnDropEventData.data);
98         break;
99       case GHOST_kDragnDropTypeFilenames: {
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       } break;
109       case GHOST_kDragnDropTypeString:
110         free(m_dragnDropEventData.data);
111         break;
112
113       default:
114         break;
115     }
116   }
117
118  protected:
119   /** The x,y-coordinates of the cursor position. */
120   GHOST_TEventDragnDropData m_dragnDropEventData;
121 };
122
123 #endif  // __GHOST_EVENTDRAGNDROP_H__