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