Merged changes in the trunk up to revision 50607.
[blender.git] / intern / ghost / intern / GHOST_DropTargetX11.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2012 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Sergey Sharybin.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_DropTargetWin32.h
29  *  \ingroup GHOST
30  */
31
32 #ifndef __GHOST_DROPTARGETX11_H__
33 #define __GHOST_DROPTARGETX11_H__
34
35 #include <GHOST_Types.h>
36 #include "GHOST_WindowX11.h"
37 #include "GHOST_SystemX11.h"
38
39 #include "xdnd.h"
40
41 class GHOST_DropTargetX11
42 {
43 public:
44         /**
45          * Constructor
46          *
47          * \param window        The window to register as drop target.
48          * \param system        The associated system.
49          */
50         GHOST_DropTargetX11(GHOST_WindowX11 *window, GHOST_SystemX11 *system);
51
52         /**
53          * Destructor
54          */
55         ~GHOST_DropTargetX11();
56
57         /**
58          * Handler of ClientMessage X11 event
59          */
60         bool GHOST_HandleClientMessage(XEvent *event);
61
62         /**
63          * Get data to pass in event.
64          * It checks the type and calls specific functions for each type.
65          * \param dropType - type of dropped entity.
66          * \param dropBuffer - buffer returned from source application
67          * \param dropBufferSize - size of returned buffer
68          * \return Pointer to data.
69          */
70         void *getGhostData(Atom dropType, unsigned char *dropBuffer, int dropBufferSize);
71
72 private:
73         /* Internal helper functions */
74
75         /**
76          * Initiailize XDND and all related X atoms
77          */
78         void Initialize(void);
79
80         /**
81          * Uninitiailize XDND and all related X atoms
82          */
83         void Uninitialize(void);
84
85         /**
86          * Get data to be passed to event from text/uri-list mime type
87          * \param dropBuffer - buffer returned from source application
88          * \param dropBufferSize - size of dropped buffer
89          * \return pointer to newly created GHOST data
90          */
91         void *getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
92
93         /**
94          * Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
95          * \param decodedOut - buffer for decoded URL
96          * \param bufferSize - size of output buffer
97          * \param encodedIn - input encoded buffer to be decoded
98          */
99         void UrlDecode(char *decodedOut, int bufferSize, const char *encodedIn);
100
101         /**
102          * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
103          * \param fileUrl - file path URL to be fully decoded
104          * \return decoded file path (resutl shold be free-d)
105          */
106         char *FileUrlDecode(char *fileUrl);
107
108         /* The associated GHOST_WindowWin32. */
109         GHOST_WindowX11 *m_window;
110         /* The System. */
111         GHOST_SystemX11 *m_system;
112
113         /* Data type of the dragged object */
114         GHOST_TDragnDropTypes m_draggedObjectType;
115
116         /* is dnd stuff initialzied */
117         static bool m_xdndInitialized;
118
119         /* class holding internal stiff of xdnd library */
120         static DndClass m_dndClass;
121
122         /* list of supported types to eb draggeg into */
123         static Atom *m_dndTypes;
124
125         /* list of supported dran'n'drop actions */
126         static Atom *m_dndActions;
127
128         /* List of supported MIME types to be dragged into */
129         static const char *m_dndMimeTypes[];
130
131         /* counter of references to global XDND structures */
132         static int m_refCounter;
133 };
134
135 #endif  // __GHOST_DROPTARGETX11_H__