Drag & drop implementation at GHOST level (only OSX for now)
[blender.git] / intern / ghost / intern / GHOST_EventDragnDrop.h
1 /**
2  * $Id: GHOST_EventDragnDrop.h 13161 2008-01-07 19:13:47Z hos $
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifndef _GHOST_EVENT_DRAGNDROP_H_
30 #define _GHOST_EVENT_DRAGNDROP_H_
31
32 #include "GHOST_Event.h"
33
34 /**
35  * Drag & drop event
36  * 
37  * The dragging sequence is performed in four phases:
38  * 
39  * <li> Start sequence (GHOST_kEventDraggingEntered) that tells a drag'n'drop operation has started. Already gives the object data type,
40  * and the entering mouse location
41  *
42  * <li> Update mouse position (GHOST_kEventDraggingUpdated) sent upon each mouse move until the drag'n'drop operation stops, to give the updated mouse position.
43  * Useful to highlight a potential destination, and update the status (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). This can happen when the user drops an object
51  * on the application icon. (Also used in OSX to pass the filename of the document the user doubled-clicked in the finder)
52  *
53  * <br><br>Note that the event handler is responsible for freeing the received data.
54  * <br>And 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 image
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 occured
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, GHOST_TEventType type, GHOST_TDragnDropTypes dataType, GHOST_IWindow* window,
75                                                  int x, int y, GHOST_TEventDataPtr data)
76                 : GHOST_Event(time, type, window)
77         {
78                 m_dragnDropEventData.x = x;
79                 m_dragnDropEventData.y = y;
80                 m_dragnDropEventData.dataType = dataType;
81                 m_dragnDropEventData.data = data;
82                 m_data = &m_dragnDropEventData;
83         }
84
85 protected:
86         /** The x,y-coordinates of the cursor position. */
87         GHOST_TEventDragnDropData m_dragnDropEventData;
88 };
89
90 #endif // _GHOST_EVENT_DRAGNDROP_H_
91