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