svn merge ^/trunk/blender -r44204:44213
[blender.git] / intern / ghost / intern / GHOST_WindowX11.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_WindowX11.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_WindowX11 class.
31  */
32
33 #ifndef __GHOST_WINDOWX11_H__
34 #define __GHOST_WINDOWX11_H__
35
36 #include "GHOST_Window.h"
37 #include <X11/Xlib.h>
38 #include <GL/glx.h>
39 // For tablets
40 #ifdef WITH_X11_XINPUT
41 #  include <X11/extensions/XInput.h>
42 #endif
43
44 #include <map>
45
46 class STR_String;
47 class GHOST_SystemX11;
48
49 #ifdef WITH_XDND
50 class GHOST_DropTargetX11;
51 #endif
52
53 /**
54  * X11 implementation of GHOST_IWindow.
55  * Dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
56  * @author      Laurence Bourn
57  * @date        October 26, 2001
58  */
59
60 class GHOST_WindowX11 : public GHOST_Window
61 {
62 public:
63         /**
64          * Constructor.
65          * Creates a new window and opens it.
66          * To check if the window was created properly, use the getValid() method.
67          * @param title         The text shown in the title bar of the window.
68          * @param left          The coordinate of the left edge of the window.
69          * @param top           The coordinate of the top edge of the window.
70          * @param width         The width the window.
71          * @param height        The height the window.
72          * @param state         The state the window is initially opened with.
73          * @param parentWindow  Parent (embedder) window
74          * @param type          The type of drawing context installed in this window.
75          * @param stereoVisual  Stereo visual for quad buffered stereo.
76          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
77          */
78         GHOST_WindowX11(
79                 GHOST_SystemX11 *system,
80                 Display * display,
81                 const STR_String& title, 
82                 GHOST_TInt32 left,
83                 GHOST_TInt32 top,
84                 GHOST_TUns32 width,     
85                 GHOST_TUns32 height,
86                 GHOST_TWindowState state,
87                 const GHOST_TEmbedderWindowID parentWindow,
88                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
89                 const bool stereoVisual = false,
90                 const GHOST_TUns16 numOfAASamples = 0
91         );
92
93                 bool 
94         getValid(
95         ) const;
96
97                 void 
98         setTitle(const STR_String& title);
99
100                 void 
101         getTitle(
102                 STR_String& title
103         ) const;
104
105                 void 
106         getWindowBounds(
107                 GHOST_Rect& bounds
108         ) const;
109         
110                 void 
111         getClientBounds(
112                 GHOST_Rect& bounds
113         ) const;
114
115                 GHOST_TSuccess 
116         setClientWidth(
117                 GHOST_TUns32 width
118         );
119
120                 GHOST_TSuccess 
121         setClientHeight(
122                 GHOST_TUns32 height
123         );
124
125                 GHOST_TSuccess 
126         setClientSize(
127                 GHOST_TUns32 width,
128                 GHOST_TUns32 height
129         );
130
131                 void 
132         screenToClient(
133                 GHOST_TInt32 inX,
134                 GHOST_TInt32 inY,
135                 GHOST_TInt32& outX,
136                 GHOST_TInt32& outY
137         ) const;
138
139                 void 
140         clientToScreen(
141                 GHOST_TInt32 inX,
142                 GHOST_TInt32 inY,
143                 GHOST_TInt32& outX,
144                 GHOST_TInt32& outY
145         ) const;
146         
147                 GHOST_TWindowState 
148         getState(
149         ) const ;
150
151                 GHOST_TSuccess 
152         setState(
153                 GHOST_TWindowState state
154         );
155         
156                 GHOST_TSuccess 
157         setOrder(
158                 GHOST_TWindowOrder order
159         );
160         
161                 GHOST_TSuccess 
162         swapBuffers(
163         );
164         
165                 GHOST_TSuccess 
166         activateDrawingContext(
167         );
168                 GHOST_TSuccess 
169         invalidate(
170         );
171
172         /**
173          * Destructor.
174          * Closes the window and disposes resources allocated.
175          */
176          ~GHOST_WindowX11();
177
178         /**
179          * @section x11specific X11 system specific calls
180          */
181
182         /**
183          * The reverse of invalidate! Tells this window
184          * that all events for it have been pushed into
185          * the GHOST event queue.
186          */
187
188                 void
189         validate(
190         );      
191
192         /**     
193          * Return a handle to the x11 window type.
194          */
195                 Window 
196         getXWindow(
197         );      
198 #ifdef WITH_X11_XINPUT
199         class XTablet
200         {
201         public:
202                 GHOST_TabletData CommonData;
203
204                 XDevice* StylusDevice;
205                 XDevice* EraserDevice;
206
207                 XID StylusID, EraserID;
208
209                 int MotionEvent;
210                 int ProxInEvent;
211                 int ProxOutEvent;
212
213                 int PressureLevels;
214                 int XtiltLevels, YtiltLevels;
215         };
216
217         XTablet& GetXTablet()
218         { return m_xtablet; }
219
220         const GHOST_TabletData* GetTabletData()
221         { return &m_xtablet.CommonData; }
222 #else // WITH_X11_XINPUT
223         const GHOST_TabletData* GetTabletData()
224         { return NULL; }
225 #endif // WITH_X11_XINPUT
226
227 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
228         XIC getX11_XIC() { return m_xic; }
229 #endif
230
231 #ifdef WITH_XDND
232         GHOST_DropTargetX11* getDropTarget()
233         { return m_dropTarget; }
234 #endif
235
236         /*
237          * Need this in case that we want start the window
238          * in FullScree or Maximized state.
239          * Check GHOST_WindowX11.cpp
240          */
241         bool m_post_init;
242         GHOST_TWindowState m_post_state;
243
244 protected:
245         /**
246          * Tries to install a rendering context in this window.
247          * @param type  The type of rendering context installed.
248          * @return Indication as to whether installation has succeeded.
249          */
250                 GHOST_TSuccess 
251         installDrawingContext(
252                 GHOST_TDrawingContextType type
253         );
254
255         /**
256          * Removes the current drawing context.
257          * @return Indication as to whether removal has succeeded.
258          */
259                 GHOST_TSuccess 
260         removeDrawingContext(
261         );
262
263         /**
264          * Sets the cursor visibility on the window using
265          * native window system calls.
266          */
267                 GHOST_TSuccess 
268         setWindowCursorVisibility(
269                 bool visible
270         );
271         
272         /**
273          * Sets the cursor grab on the window using
274          * native window system calls.
275          * @param warp  Only used when grab is enabled, hides the mouse and allows gragging outside the screen.
276          */
277                 GHOST_TSuccess 
278         setWindowCursorGrab(
279                 GHOST_TGrabCursorMode mode
280         );
281
282                 GHOST_TGrabCursorMode
283         getWindowCursorGrab() const;
284
285         /**
286          * Sets the cursor shape on the window using
287          * native window system calls.
288          */
289                 GHOST_TSuccess 
290         setWindowCursorShape(
291                 GHOST_TStandardCursor shape
292         );
293
294         /**
295          * Sets the cursor shape on the window using
296          * native window system calls.
297          */
298                 GHOST_TSuccess
299         setWindowCustomCursorShape(
300                 GHOST_TUns8 bitmap[16][2], 
301                 GHOST_TUns8 mask[16][2], 
302                 int hotX, 
303                 int hotY
304         );
305         
306         /**
307          * Sets the cursor shape on the window using
308          * native window system calls (Arbitrary size/color).
309          */
310                 GHOST_TSuccess
311         setWindowCustomCursorShape(
312                 GHOST_TUns8 *bitmap, 
313                 GHOST_TUns8 *mask, 
314                 int sizex, 
315                 int sizey,
316                 int hotX, 
317                 int hotY,
318                 int fg_color, 
319                 int bg_color
320         );
321
322 private :
323
324         /// Force use of public constructor.
325         
326         GHOST_WindowX11(
327         );
328
329         GHOST_WindowX11(
330                 const GHOST_WindowX11 &
331         );
332
333                 Cursor
334         getStandardCursor(
335                 GHOST_TStandardCursor g_cursor
336         );
337         
338                 Cursor 
339         getEmptyCursor(
340         );
341
342 #ifdef WITH_X11_XINPUT
343         void initXInputDevices();
344 #endif
345         
346         GLXContext      m_context;
347         Window  m_window;
348         Display         *m_display;
349         XVisualInfo     *m_visual;
350         GHOST_TWindowState m_normal_state;
351
352         /** The first created OpenGL context (for sharing display lists) */
353         static GLXContext s_firstContext;
354
355         /// A pointer to the typed system class.
356         
357         GHOST_SystemX11 * m_system;
358
359         bool m_valid_setup;
360
361         /** Used to concatenate calls to invalidate() on this window. */
362         bool m_invalid_window;
363
364         /** XCursor structure of an empty (blank) cursor */
365         Cursor m_empty_cursor;
366         
367         /** XCursor structure of the custom cursor */
368         Cursor m_custom_cursor;
369         
370         /** Cache of XC_* ID's to XCursor structures */
371         std::map<unsigned int, Cursor> m_standard_cursors;
372
373 #ifdef WITH_XDND
374         GHOST_DropTargetX11 * m_dropTarget;
375 #endif
376
377 #ifdef WITH_X11_XINPUT
378         /* Tablet devices */
379         XTablet m_xtablet;
380 #endif
381
382 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
383         XIC m_xic;
384 #endif
385
386         void icccmSetState(int state);
387         int icccmGetState() const;
388
389         void netwmMaximized(bool set);
390         bool netwmIsMaximized() const;
391
392         void netwmFullScreen(bool set);
393         bool netwmIsFullScreen() const;
394
395         void motifFullScreen(bool set);
396         bool motifIsFullScreen() const;
397 };
398
399
400 #endif // __GHOST_WINDOWX11_H__