d998e86c9b15756c0ef19ead6bd7f5b479fa7054
[blender.git] / intern / ghost / intern / GHOST_WindowWin32.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_WindowWin32.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_WindowWin32 class.
31  */
32
33 #ifndef __GHOST_WINDOWWIN32_H__
34 #define __GHOST_WINDOWWIN32_H__
35
36 #ifndef WIN32
37 #error WIN32 only!
38 #endif // WIN32
39
40 #include "GHOST_Window.h"
41 #include "GHOST_TaskbarWin32.h"
42 #ifdef WITH_INPUT_IME
43 #  include "GHOST_ImeWin32.h"
44 #endif
45
46 #include <wintab.h>
47 #define PACKETDATA  (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR)
48 #define PACKETMODE  PK_BUTTONS
49 #include <pktdef.h>
50
51 class GHOST_SystemWin32;
52 class GHOST_DropTargetWin32;
53
54 // typedefs for WinTab functions to allow dynamic loading
55 typedef UINT (API * GHOST_WIN32_WTInfo)(UINT, UINT, LPVOID);
56 typedef HCTX (API * GHOST_WIN32_WTOpen)(HWND, LPLOGCONTEXTA, BOOL);
57 typedef BOOL (API * GHOST_WIN32_WTClose)(HCTX);
58 typedef BOOL (API * GHOST_WIN32_WTPacket)(HCTX, UINT, LPVOID);
59 typedef BOOL (API * GHOST_WIN32_WTOverlap)(HCTX, BOOL);
60
61 // typedefs for user32 functions to allow dynamic loading of Windows 10 DPI scaling functions
62 typedef UINT(API * GHOST_WIN32_GetDpiForWindow)(HWND);
63 #ifndef USER_DEFAULT_SCREEN_DPI
64 #define USER_DEFAULT_SCREEN_DPI 96
65 #endif // USER_DEFAULT_SCREEN_DPI
66
67 /**
68  * GHOST window on M$ Windows OSs.
69  * \author      Maarten Gribnau
70  * \date        May 10, 2001
71  */
72 class GHOST_WindowWin32 : public GHOST_Window {
73 public:
74         /**
75          * Constructor.
76          * Creates a new window and opens it.
77          * To check if the window was created properly, use the getValid() method.
78          * \param title         The text shown in the title bar of the window.
79          * \param left          The coordinate of the left edge of the window.
80          * \param top           The coordinate of the top edge of the window.
81          * \param width         The width the window.
82          * \param height        The height the window.
83          * \param state         The state the window is initially opened with.
84          * \param type          The type of drawing context installed in this window.
85          * \param wantStereoVisual   Stereo visual for quad buffered stereo.
86          * \param wantNumOfAASamples Number of samples used for AA (zero if no AA)
87          * \param parentWindowHwnd
88          */
89         GHOST_WindowWin32(GHOST_SystemWin32 *system,
90             const STR_String& title,
91             GHOST_TInt32 left,
92             GHOST_TInt32 top,
93             GHOST_TUns32 width,
94             GHOST_TUns32 height,
95             GHOST_TWindowState state,
96             GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
97             bool wantStereoVisual = false,
98             bool alphaBackground = false,
99             GHOST_TUns16 wantNumOfAASamples = 0,
100             GHOST_TEmbedderWindowID parentWindowHwnd = 0,
101             bool is_debug = false);
102
103         /**
104          * Destructor.
105          * Closes the window and disposes resources allocated.
106          */
107         ~GHOST_WindowWin32();
108
109         /**
110          * Returns indication as to whether the window is valid.
111          * \return The validity of the window.
112          */
113         bool getValid() const;
114
115         /**
116          * Access to the handle of the window.
117          * \return The handle of the window.
118          */
119         HWND getHWND() const;
120
121         /**
122          * Sets the title displayed in the title bar.
123          * \param title The title to display in the title bar.
124          */
125         void setTitle(const STR_String& title);
126
127         /**
128          * Returns the title displayed in the title bar.
129          * \param title The title displayed in the title bar.
130          */
131         void getTitle(STR_String& title) const;
132
133         /**
134          * Returns the window rectangle dimensions.
135          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
136          * \param bounds The bounding rectangle of the window.
137          */
138         void getWindowBounds(GHOST_Rect& bounds) const;
139
140         /**
141          * Returns the client rectangle dimensions.
142          * The left and top members of the rectangle are always zero.
143          * \param bounds The bounding rectangle of the client area of the window.
144          */
145         void getClientBounds(GHOST_Rect& bounds) const;
146
147         /**
148          * Resizes client rectangle width.
149          * \param width The new width of the client area of the window.
150          */
151         GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
152
153         /**
154          * Resizes client rectangle height.
155          * \param height The new height of the client area of the window.
156          */
157         GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
158
159         /**
160          * Resizes client rectangle.
161          * \param width         The new width of the client area of the window.
162          * \param height        The new height of the client area of the window.
163          */
164         GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
165
166         /**
167          * Returns the state of the window (normal, minimized, maximized).
168          * \return The state of the window.
169          */
170         GHOST_TWindowState getState() const;
171
172         /**
173          * Converts a point in screen coordinates to client rectangle coordinates
174          * \param inX   The x-coordinate on the screen.
175          * \param inY   The y-coordinate on the screen.
176          * \param outX  The x-coordinate in the client rectangle.
177          * \param outY  The y-coordinate in the client rectangle.
178          */
179         void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
180
181         /**
182          * Converts a point in screen coordinates to client rectangle coordinates
183          * \param inX   The x-coordinate in the client rectangle.
184          * \param inY   The y-coordinate in the client rectangle.
185          * \param outX  The x-coordinate on the screen.
186          * \param outY  The y-coordinate on the screen.
187          */
188         void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
189
190         /**
191          * Sets the state of the window (normal, minimized, maximized).
192          * \param state The state of the window.
193          * \return Indication of success.
194          */
195         GHOST_TSuccess setState(GHOST_TWindowState state);
196
197         /**
198          * Sets the order of the window (bottom, top).
199          * \param order The order of the window.
200          * \return Indication of success.
201          */
202         GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
203
204         /**
205          * Invalidates the contents of this window.
206          */
207         GHOST_TSuccess invalidate();
208
209         /**
210          * Sets the progress bar value displayed in the window/application icon
211          * \param progress The progress %
212          */
213         GHOST_TSuccess setProgressBar(float progress);
214
215         /**
216          * Hides the progress bar in the icon
217          */
218         GHOST_TSuccess endProgressBar();
219
220
221         /**
222          * Register a mouse click event (should be called
223          * for any real button press, controls mouse
224          * capturing).
225          *
226          * \param press
227          *              0 - mouse pressed
228          *              1 - mouse released
229          *              2 - operator grab
230          *              3 - operator ungrab
231          */
232         void registerMouseClickEvent(int press);
233
234         /**
235          * Inform the window that it has lost mouse capture,
236          * called in response to native window system messages.
237          */
238         void lostMouseCapture();
239
240         /**
241          * Loads the windows equivalent of a standard GHOST cursor.
242          * \param visible               Flag for cursor visibility.
243          * \param cursorShape   The cursor shape.
244          */
245         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
246
247         const GHOST_TabletData *GetTabletData()
248         {
249                 return m_tabletData;
250         }
251
252         void processWin32TabletInitEvent();
253         void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);
254         void bringTabletContextToFront();
255
256         GHOST_TSuccess beginFullScreen() const {return GHOST_kFailure;}
257
258         GHOST_TSuccess endFullScreen() const {return GHOST_kFailure;}
259
260         GHOST_TUns16 getDPIHint() override;
261
262         /** if the window currently resizing */
263         bool m_inLiveResize;
264
265 #ifdef WITH_INPUT_IME
266         GHOST_ImeWin32 *getImeInput() {return &m_imeImput;}
267
268         void beginIME(
269                 GHOST_TInt32 x, GHOST_TInt32 y,
270                 GHOST_TInt32 w, GHOST_TInt32 h,
271                 int completed);
272
273         void endIME();
274 #endif /* WITH_INPUT_IME */
275
276 private:
277
278         /**
279          * \param type  The type of rendering context create.
280          * \return Indication of success.
281          */
282         GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);
283
284         /**
285          * Sets the cursor visibility on the window using
286          * native window system calls.
287          */
288         GHOST_TSuccess setWindowCursorVisibility(bool visible);
289
290         /**
291          * Sets the cursor grab on the window using native window system calls.
292          * Using registerMouseClickEvent.
293          * \param mode  GHOST_TGrabCursorMode.
294          */
295         GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
296
297         /**
298          * Sets the cursor shape on the window using
299          * native window system calls.
300          */
301         GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
302
303         /**
304          * Sets the cursor shape on the window using
305          * native window system calls.
306          */
307         GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2],
308                                                           GHOST_TUns8 mask[16][2],
309                                                           int hotX, int hotY);
310
311         GHOST_TSuccess 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         /** Pointer to system */
323         GHOST_SystemWin32 *m_system;
324         /** Pointer to COM IDropTarget implementor */
325         GHOST_DropTargetWin32 *m_dropTarget;
326         /** Window handle. */
327         HWND m_hWnd;
328         /** Device context handle. */
329         HDC m_hDC;
330
331         /** Flag for if window has captured the mouse */
332         bool m_hasMouseCaptured;
333         /** Flag if an operator grabs the mouse with WM_cursor_grab_enable/ungrab()
334          * Multiple grabs must be released with a single ungrab */
335         bool m_hasGrabMouse;
336         /** Count of number of pressed buttons */
337         int m_nPressedButtons;
338         /** HCURSOR structure of the custom cursor */
339         HCURSOR m_customCursor;
340         /** request GL context aith alpha channel */
341         bool m_wantAlphaBackground;
342
343         /** ITaskbarList3 structure for progress bar*/
344         ITaskbarList3 *m_Bar;
345
346         static const wchar_t *s_windowClassName;
347         static const int s_maxTitleLength;
348
349         /** WinTab dll handle */
350         HMODULE m_wintab;
351
352         /** Tablet data for GHOST */
353         GHOST_TabletData *m_tabletData;
354
355         /** Stores the Tablet context if detected Tablet features using WinTab.dll */
356         HCTX m_tablet;
357         LONG m_maxPressure;
358         LONG m_maxAzimuth, m_maxAltitude;
359
360         GHOST_TWindowState m_normal_state;
361
362         /** user32 dll handle*/
363         HMODULE m_user32;
364
365         /** Hwnd to parent window */
366         GHOST_TEmbedderWindowID m_parentWindowHwnd;
367
368 #ifdef WITH_INPUT_IME
369         /** Handle input method editors event */
370         GHOST_ImeWin32 m_imeImput;
371 #endif
372         bool m_debug_context;
373 };
374
375 #endif // __GHOST_WINDOWWIN32_H__