GHOST_WindowWin32.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#ifndef WIN32
#  error WIN32 only!
#endif /* WIN32 */
 
#include "GHOST_TaskbarWin32.hh"
#include "GHOST_TrackpadWin32.hh"
#include "GHOST_Window.hh"
#include "GHOST_Wintab.hh"
#ifdef WITH_INPUT_IME
#  include "GHOST_ImeWin32.hh"
#endif
 
#include <vector>
 
class GHOST_SystemWin32;
class GHOST_DropTargetWin32;
 
/* typedefs for user32 functions to allow dynamic loading of Windows 10 DPI scaling functions. */
typedef UINT(API *GHOST_WIN32_GetDpiForWindow)(HWND);
 
typedef BOOL(API *GHOST_WIN32_AdjustWindowRectExForDpi)(
    LPRECT lpRect, DWORD dwStyle, BOOL bMenu, DWORD dwExStyle, UINT dpi);
 
struct GHOST_PointerInfoWin32 {
  int32_t pointerId;
  int32_t isPrimary;
  GHOST_TButton buttonMask;
  POINT pixelLocation;
  uint64_t time;
  GHOST_TabletData tabletData;
};
 
typedef enum {
  MousePressed,
  MouseReleased,
  OperatorGrab,
  OperatorUngrab
} GHOST_MouseCaptureEventWin32;

class GHOST_WindowWin32 : public GHOST_Window {
 public:
  GHOST_WindowWin32(GHOST_SystemWin32 *system,
                    const char *title,
                    int32_t left,
                    int32_t top,
                    uint32_t width,
                    uint32_t height,
                    GHOST_TWindowState state,
                    GHOST_TDrawingContextType type,
                    bool wantStereoVisual,
                    GHOST_WindowWin32 *parentWindow,
                    bool is_debug,
                    bool dialog,
                    const GHOST_GPUDevice &preferred_device);

  ~GHOST_WindowWin32();

  void adjustWindowRectForClosestMonitor(LPRECT win_rect, DWORD dwStyle, DWORD dwExStyle);

  bool getValid() const;

  HWND getHWND() const;

  void *getOSWindow() const;

  void setTitle(const char *title);

  std::string getTitle() const;

  GHOST_TSuccess applyWindowDecorationStyle() override;

  void getWindowBounds(GHOST_Rect &bounds) const;

  void getClientBounds(GHOST_Rect &bounds) const;

  GHOST_TSuccess setClientWidth(uint32_t width);

  GHOST_TSuccess setClientHeight(uint32_t height);

  GHOST_TSuccess setClientSize(uint32_t width, uint32_t height);

  GHOST_TWindowState getState() const;

  void screenToClient(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const;

  void clientToScreen(int32_t inX, int32_t inY, int32_t &outX, int32_t &outY) const;

  GHOST_TSuccess setState(GHOST_TWindowState state);

  GHOST_TSuccess setOrder(GHOST_TWindowOrder order);

  GHOST_TSuccess invalidate();

  GHOST_TSuccess setProgressBar(float progress);

  GHOST_TSuccess endProgressBar();

  void updateMouseCapture(GHOST_MouseCaptureEventWin32 event);

  void lostMouseCapture();
 
  bool isDialog() const;

  HCURSOR getStandardCursor(GHOST_TStandardCursor shape) const;
  void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;

  bool usingTabletAPI(GHOST_TTabletAPI api) const;

  GHOST_TSuccess getPointerInfo(std::vector<GHOST_PointerInfoWin32> &outPointerInfo,
                                WPARAM wParam,
                                LPARAM lParam);

  void resetPointerPenInfo();

  GHOST_Wintab *getWintab() const;

  void loadWintab(bool enable);

  void closeWintab();

  GHOST_TabletData getTabletData();
 
  void updateDPI();
 
  uint16_t getDPIHint() override;

  bool m_mousePresent;

  bool m_inLiveResize;

  void ThemeRefresh();
 
#ifdef WITH_INPUT_IME
  GHOST_ImeWin32 *getImeInput()
  {
    return &m_imeInput;
  }
 
  void beginIME(int32_t x, int32_t y, int32_t w, int32_t h, bool completed);
 
  void endIME();
#endif /* WITH_INPUT_IME */
 
  /*
   * Drive DirectManipulation context.
   */
  void updateDirectManipulation();
 
  /*
   * Handle DM_POINTERHITTEST events.
   * \param wParam: wParam from the event.
   */
  void onPointerHitTest(WPARAM wParam);
 
  GHOST_TTrackpadInfo getTrackpadInfo();
 
 private:
  GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);

  GHOST_TSuccess setWindowCursorVisibility(bool visible);

  GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);

  GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
  GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor shape);

  GHOST_TSuccess setWindowCustomCursorShape(uint8_t *bitmap,
                                            uint8_t *mask,
                                            int sizex,
                                            int sizey,
                                            int hotX,
                                            int hotY,
                                            bool canInvertColor);
 
  /* Registration of the AppModel Properties that govern the taskbar button and jump lists. */
  void registerWindowAppUserModelProperties();
  void unregisterWindowAppUserModelProperties();

  GHOST_SystemWin32 *m_system;
  GHOST_DropTargetWin32 *m_dropTarget;
  HWND m_hWnd;
  HDC m_hDC;
 
  bool m_isDialog;
  GHOST_GPUDevice m_preferred_device;

  bool m_hasMouseCaptured;
  bool m_hasGrabMouse;
  int m_nPressedButtons;
  HCURSOR m_customCursor;

  ITaskbarList3 *m_Bar;
 
  static const wchar_t *s_windowClassName;
  static const int s_maxTitleLength;

  GHOST_Wintab *m_wintab;

  GHOST_TabletData m_lastPointerTabletData;
 
  GHOST_TWindowState m_normal_state;

  HMODULE m_user32;
 
  HWND m_parentWindowHwnd;
 
  GHOST_DirectManipulationHelper *m_directManipulationHelper;
 
#ifdef WITH_INPUT_IME
  GHOST_ImeWin32 m_imeInput;
#endif
  bool m_debug_context;
};