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