Apply patch [#20145] Ghost Win32 roundup patch: Minimum Window Size, Continuous Grab...
[blender.git] / intern / ghost / intern / GHOST_WindowWin32.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_WindowWin32.h
30  * Declaration of GHOST_WindowWin32 class.
31  */
32
33 #ifndef _GHOST_WINDOW_WIN32_H_
34 #define _GHOST_WINDOW_WIN32_H_
35
36 #ifndef WIN32
37 #error WIN32 only!
38 #endif // WIN32
39
40 #include "GHOST_Window.h"
41
42 #include <windows.h>
43
44
45 #include <wintab.h>
46 #define PACKETDATA      (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR)
47 #define PACKETMODE      PK_BUTTONS
48 #include <pktdef.h>
49
50 class GHOST_SystemWin32;
51 class GHOST_DropTargetWin32;
52
53 // typedefs for WinTab functions to allow dynamic loading
54 typedef UINT (API * GHOST_WIN32_WTInfo) ( UINT, UINT, LPVOID );
55 typedef HCTX (API * GHOST_WIN32_WTOpen) (HWND, LPLOGCONTEXTA, BOOL);
56 typedef BOOL (API * GHOST_WIN32_WTClose) (HCTX);
57 typedef BOOL (API * GHOST_WIN32_WTPacket) (HCTX, UINT, LPVOID);
58
59 /**
60  * GHOST window on M$ Windows OSs.
61  * @author      Maarten Gribnau
62  * @date        May 10, 2001
63  */
64 class GHOST_WindowWin32 : public GHOST_Window {
65 public:
66         /**
67          * Constructor.
68          * Creates a new window and opens it.
69          * To check if the window was created properly, use the getValid() method.
70          * @param title         The text shown in the title bar of the window.
71          * @param left          The coordinate of the left edge of the window.
72          * @param top           The coordinate of the top edge of the window.
73          * @param width         The width the window.
74          * @param height        The height the window.
75          * @param state         The state the window is initially opened with.
76          * @param type          The type of drawing context installed in this window.
77          * @param stereoVisual  Stereo visual for quad buffered stereo.
78          */
79         GHOST_WindowWin32(
80                 GHOST_SystemWin32 * system,
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                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
88                 const bool stereoVisual = false
89         );
90
91         /**
92          * Destructor.
93          * Closes the window and disposes resources allocated.
94          */
95         virtual ~GHOST_WindowWin32();
96
97         /**
98          * Returns indication as to whether the window is valid.
99          * @return The validity of the window.
100          */
101         virtual bool getValid() const;
102
103         /**
104          * Access to the handle of the window.
105          * @return The handle of the window.
106          */
107         virtual HWND getHWND() const;
108
109         /**
110          * Sets the title displayed in the title bar.
111          * @param title The title to display in the title bar.
112          */
113         virtual void setTitle(const STR_String& title);
114
115         /**
116          * Returns the title displayed in the title bar.
117          * @param title The title displayed in the title bar.
118          */
119         virtual void getTitle(STR_String& title) const;
120
121         /**
122          * Returns the window rectangle dimensions.
123          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
124          * @param bounds The bounding rectangle of the window.
125          */
126         virtual void getWindowBounds(GHOST_Rect& bounds) const;
127         
128         /**
129          * Returns the client rectangle dimensions.
130          * The left and top members of the rectangle are always zero.
131          * @param bounds The bounding rectangle of the cleient area of the window.
132          */
133         virtual void getClientBounds(GHOST_Rect& bounds) const;
134
135         /**
136          * Resizes client rectangle width.
137          * @param width The new width of the client area of the window.
138          */
139         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
140
141         /**
142          * Resizes client rectangle height.
143          * @param height The new height of the client area of the window.
144          */
145         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
146
147         /**
148          * Resizes client rectangle.
149          * @param width         The new width of the client area of the window.
150          * @param height        The new height of the client area of the window.
151          */
152         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
153
154         /**
155          * Returns the state of the window (normal, minimized, maximized).
156          * @return The state of the window.
157          */
158         virtual GHOST_TWindowState getState() const;
159
160         /**
161          * Converts a point in screen coordinates to client rectangle coordinates
162          * @param inX   The x-coordinate on the screen.
163          * @param inY   The y-coordinate on the screen.
164          * @param outX  The x-coordinate in the client rectangle.
165          * @param outY  The y-coordinate in the client rectangle.
166          */
167         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
168
169         /**
170          * Converts a point in screen coordinates to client rectangle coordinates
171          * @param inX   The x-coordinate in the client rectangle.
172          * @param inY   The y-coordinate in the client rectangle.
173          * @param outX  The x-coordinate on the screen.
174          * @param outY  The y-coordinate on the screen.
175          */
176         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
177
178         /**
179          * Sets the state of the window (normal, minimized, maximized).
180          * @param state The state of the window.
181          * @return Indication of success.
182          */
183         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
184
185         /**
186          * Sets the order of the window (bottom, top).
187          * @param order The order of the window.
188          * @return Indication of success.
189          */
190         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
191
192         /**
193          * Swaps front and back buffers of a window.
194          * @return Indication of success.
195          */
196         virtual GHOST_TSuccess swapBuffers();
197
198         /**
199          * Activates the drawing context of this window.
200          * @return Indication of success.
201          */
202         virtual GHOST_TSuccess activateDrawingContext();
203
204         /**
205          * Invalidates the contents of this window.
206          */
207         virtual GHOST_TSuccess invalidate();
208
209         /**
210          * Returns the name of the window class.
211          * @return The name of the window class.
212          */
213         static LPCSTR getWindowClassName() { return s_windowClassName; }
214
215         /**
216          * Register a mouse click event (should be called 
217          * for any real button press, controls mouse
218          * capturing).
219          *
220          * @param press True the event was a button press.
221          */
222         void registerMouseClickEvent(bool press);
223
224         /**
225          * Inform the window that it has lost mouse capture,
226          * called in response to native window system messages.
227          */
228         void lostMouseCapture();
229
230         /**
231          * Loads the windows equivalent of a standard GHOST cursor.
232          * @param visible               Flag for cursor visibility.
233          * @param cursorShape   The cursor shape.
234          */
235         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
236
237         const GHOST_TabletData* GetTabletData()
238         { return m_tabletData; }
239
240         void processWin32TabletInitEvent();
241         void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);
242
243 protected:
244         /**
245          * Tries to install a rendering context in this window.
246          * @param type  The type of rendering context installed.
247          * @return Indication of success.
248          */
249         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
250
251         /**
252          * Removes the current drawing context.
253          * @return Indication of success.
254          */
255         virtual GHOST_TSuccess removeDrawingContext();
256
257         /**
258          * Sets the cursor visibility on the window using
259          * native window system calls.
260          */
261         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
262         
263         /**
264          * Sets the cursor grab on the window using native window system calls.
265          * Using registerMouseClickEvent.
266          * @param mode  GHOST_TGrabCursorMode.
267          */
268         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
269         
270         /**
271          * Sets the cursor shape on the window using
272          * native window system calls.
273          */
274         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
275
276         /**
277          * Sets the cursor shape on the window using
278          * native window system calls.
279          */
280         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
281
282         virtual GHOST_TSuccess setWindowCustomCursorShape(
283                 GHOST_TUns8 *bitmap, 
284                 GHOST_TUns8 *mask, 
285                 int sizex, 
286                 int sizey,
287                 int hotX, 
288                 int hotY,
289                 int fg_color, 
290                 int bg_color
291         );
292         
293         /** Pointer to system */
294         GHOST_SystemWin32 * m_system;
295         /** Pointer to COM IDropTarget implementor */
296         GHOST_DropTargetWin32 * m_dropTarget;
297         /** Window handle. */
298         HWND m_hWnd;
299         /** Device context handle. */
300         HDC m_hDC;
301         /** OpenGL rendering context. */
302         HGLRC m_hGlRc;
303         /** The first created OpenGL context (for sharing display lists) */
304         static HGLRC s_firsthGLRc;
305         /** Flag for if window has captured the mouse */
306         bool m_hasMouseCaptured;
307         /** Count of number of pressed buttons */
308         int m_nPressedButtons;
309         /** HCURSOR structure of the custom cursor */
310         HCURSOR m_customCursor;
311
312         static LPCSTR s_windowClassName;
313         static const int s_maxTitleLength;
314
315         /** WinTab dll handle */
316         HMODULE m_wintab;
317
318         /** Tablet data for GHOST */
319         GHOST_TabletData* m_tabletData;
320
321         /** Stores the Tablet context if detected Tablet features using WinTab.dll */
322         HCTX m_tablet;
323         LONG m_maxPressure;
324         LONG m_maxAzimuth, m_maxAltitude;
325
326 };
327
328 #endif // _GHOST_WINDOW_WIN32_H_
329