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