Initial revision
[blender.git] / intern / ghost / intern / GHOST_WindowWin32.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 10, 2001
38  */
39
40 #ifndef _GHOST_WINDOW_WIN32_H_
41 #define _GHOST_WINDOW_WIN32_H_
42
43 #ifndef WIN32
44 #error WIN32 only!
45 #endif // WIN32
46
47 #include "GHOST_Window.h"
48
49 #include <windows.h>
50
51
52 /**
53  * GHOST window on M$ Windows OSs.
54  * @author      Maarten Gribnau
55  * @date        May 10, 2001
56  */
57
58 class GHOST_WindowWin32 : public GHOST_Window {
59 public:
60         /**
61          * Constructor.
62          * Creates a new window and opens it.
63          * To check if the window was created properly, use the getValid() method.
64          * @param title         The text shown in the title bar of the window.
65          * @param left          The coordinate of the left edge of the window.
66          * @param top           The coordinate of the top edge of the window.
67          * @param width         The width the window.
68          * @param height        The height the window.
69          * @param state         The state the window is initially opened with.
70          * @param type          The type of drawing context installed in this window.
71          * @param stereoVisual  Stereo visual for quad buffered stereo.
72          */
73         GHOST_WindowWin32(
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                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
81                 const bool stereoVisual = false
82         );
83
84         /**
85          * Destructor.
86          * Closes the window and disposes resources allocated.
87          */
88         virtual ~GHOST_WindowWin32();
89
90         /**
91          * Returns indication as to whether the window is valid.
92          * @return The validity of the window.
93          */
94         virtual bool getValid() const;
95
96         /**
97          * Sets the title displayed in the title bar.
98          * @param title The title to display in the title bar.
99          */
100         virtual void setTitle(const STR_String& title);
101
102         /**
103          * Returns the title displayed in the title bar.
104          * @param title The title displayed in the title bar.
105          */
106         virtual void getTitle(STR_String& title) const;
107
108         /**
109          * Returns the window rectangle dimensions.
110          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
111          * @param bounds The bounding rectangle of the window.
112          */
113         virtual void getWindowBounds(GHOST_Rect& bounds) const;
114         
115         /**
116          * Returns the client rectangle dimensions.
117          * The left and top members of the rectangle are always zero.
118          * @param bounds The bounding rectangle of the cleient area of the window.
119          */
120         virtual void getClientBounds(GHOST_Rect& bounds) const;
121
122         /**
123          * Resizes client rectangle width.
124          * @param width The new width of the client area of the window.
125          */
126         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
127
128         /**
129          * Resizes client rectangle height.
130          * @param height The new height of the client area of the window.
131          */
132         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
133
134         /**
135          * Resizes client rectangle.
136          * @param width         The new width of the client area of the window.
137          * @param height        The new height of the client area of the window.
138          */
139         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
140
141         /**
142          * Returns the state of the window (normal, minimized, maximized).
143          * @return The state of the window.
144          */
145         virtual GHOST_TWindowState getState() const;
146
147         /**
148          * Converts a point in screen coordinates to client rectangle coordinates
149          * @param inX   The x-coordinate on the screen.
150          * @param inY   The y-coordinate on the screen.
151          * @param outX  The x-coordinate in the client rectangle.
152          * @param outY  The y-coordinate in the client rectangle.
153          */
154         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
155
156         /**
157          * Converts a point in screen coordinates to client rectangle coordinates
158          * @param inX   The x-coordinate in the client rectangle.
159          * @param inY   The y-coordinate in the client rectangle.
160          * @param outX  The x-coordinate on the screen.
161          * @param outY  The y-coordinate on the screen.
162          */
163         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
164
165         /**
166          * Sets the state of the window (normal, minimized, maximized).
167          * @param state The state of the window.
168          * @return Indication of success.
169          */
170         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
171
172         /**
173          * Sets the order of the window (bottom, top).
174          * @param order The order of the window.
175          * @return Indication of success.
176          */
177         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
178
179         /**
180          * Swaps front and back buffers of a window.
181          * @return Indication of success.
182          */
183         virtual GHOST_TSuccess swapBuffers();
184
185         /**
186          * Activates the drawing context of this window.
187          * @return Indication of success.
188          */
189         virtual GHOST_TSuccess activateDrawingContext();
190
191         /**
192          * Invalidates the contents of this window.
193          */
194         virtual GHOST_TSuccess invalidate();
195
196         /**
197          * Returns the name of the window class.
198          * @return The name of the window class.
199          */
200         static LPCSTR getWindowClassName() { return s_windowClassName; }
201
202         /**
203          * Register a mouse click event (should be called 
204          * for any real button press, controls mouse
205          * capturing).
206          *
207          * @param press True the event was a button press.
208          */
209         void registerMouseClickEvent(bool press);
210
211         /**
212          * Inform the window that it has lost mouse capture,
213          * called in response to native window system messages.
214          */
215         void lostMouseCapture();
216
217         /**
218          * Loads the windows equivalent of a standard GHOST cursor.
219          * @param visible               Flag for cursor visibility.
220          * @param cursorShape   The cursor shape.
221          */
222         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
223
224
225 protected:
226         /**
227          * Tries to install a rendering context in this window.
228          * @param type  The type of rendering context installed.
229          * @return Indication of success.
230          */
231         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
232
233         /**
234          * Removes the current drawing context.
235          * @return Indication of success.
236          */
237         virtual GHOST_TSuccess removeDrawingContext();
238
239         /**
240          * Sets the cursor visibility on the window using
241          * native window system calls.
242          */
243         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
244         
245         /**
246          * Sets the cursor shape on the window using
247          * native window system calls.
248          */
249         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
250
251         /**
252          * Sets the cursor shape on the window using
253          * native window system calls.
254          */
255         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
256
257         /** Window handle. */
258         HWND m_hWnd;
259         /** Device context handle. */
260         HDC m_hDC;
261         /** OpenGL rendering context. */
262         HGLRC m_hGlRc;
263         /** The first created OpenGL context (for sharing display lists) */
264         static HGLRC s_firsthGLRc;
265         /** Flag for if window has captured the mouse */
266         bool m_hasMouseCaptured;
267         /** Count of number of pressed buttons */
268         int m_nPressedButtons;
269         /** HCURSOR structure of the custom cursor */
270         HCURSOR m_customCursor;
271
272         static LPCSTR s_windowClassName;
273         static const int s_maxTitleLength;
274 };
275
276 #endif // _GHOST_WINDOW_WIN32_H_