Cleanup: remove redundant, invalid info from headers
[blender.git] / intern / ghost / intern / GHOST_DropTargetX11.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) 2012 by the Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file ghost/intern/GHOST_DropTargetWin32.h
21  *  \ingroup GHOST
22  */
23
24 #ifndef __GHOST_DROPTARGETX11_H__
25 #define __GHOST_DROPTARGETX11_H__
26
27 #include <GHOST_Types.h>
28 #include "GHOST_WindowX11.h"
29 #include "GHOST_SystemX11.h"
30
31 #include "xdnd.h"
32
33 class GHOST_DropTargetX11
34 {
35 public:
36         /**
37          * Constructor
38          *
39          * \param window        The window to register as drop target.
40          * \param system        The associated system.
41          */
42         GHOST_DropTargetX11(GHOST_WindowX11 *window, GHOST_SystemX11 *system);
43
44         /**
45          * Destructor
46          */
47         ~GHOST_DropTargetX11();
48
49         /**
50          * Handler of ClientMessage X11 event
51          */
52         bool GHOST_HandleClientMessage(XEvent *event);
53
54         /**
55          * Get data to pass in event.
56          * It checks the type and calls specific functions for each type.
57          * \param dropType - type of dropped entity.
58          * \param dropBuffer - buffer returned from source application
59          * \param dropBufferSize - size of returned buffer
60          * \return Pointer to data.
61          */
62         void *getGhostData(Atom dropType, unsigned char *dropBuffer, int dropBufferSize);
63
64 private:
65         /* Internal helper functions */
66
67         /**
68          * Initialize XDND and all related X atoms
69          */
70         void Initialize(void);
71
72         /**
73          * Uninitialize XDND and all related X atoms
74          */
75         void Uninitialize(void);
76
77         /**
78          * Get data to be passed to event from text/uri-list mime type
79          * \param dropBuffer - buffer returned from source application
80          * \param dropBufferSize - size of dropped buffer
81          * \return pointer to newly created GHOST data
82          */
83         void *getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
84
85         /**
86          * Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
87          * \param decodedOut - buffer for decoded URL
88          * \param bufferSize - size of output buffer
89          * \param encodedIn - input encoded buffer to be decoded
90          */
91         void UrlDecode(char *decodedOut, int bufferSize, const char *encodedIn);
92
93         /**
94          * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
95          * \param fileUrl - file path URL to be fully decoded
96          * \return decoded file path (resutl should be free-d)
97          */
98         char *FileUrlDecode(char *fileUrl);
99
100         /* The associated GHOST_WindowWin32. */
101         GHOST_WindowX11 *m_window;
102         /* The System. */
103         GHOST_SystemX11 *m_system;
104
105         /* Data type of the dragged object */
106         GHOST_TDragnDropTypes m_draggedObjectType;
107
108         /* is dnd stuff initialzied */
109         static bool m_xdndInitialized;
110
111         /* class holding internal stiff of xdnd library */
112         static DndClass m_dndClass;
113
114         /* list of supported types to eb draggeg into */
115         static Atom *m_dndTypes;
116
117         /* list of supported dran'n'drop actions */
118         static Atom *m_dndActions;
119
120         /* List of supported MIME types to be dragged into */
121         static const char *m_dndMimeTypes[];
122
123         /* counter of references to global XDND structures */
124         static int m_refCounter;
125
126 #ifdef WITH_CXX_GUARDEDALLOC
127         MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_DropTargetX11")
128 #endif
129 };
130
131 #endif  // __GHOST_DROPTARGETX11_H__