GHOST_SystemCocoa.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 __APPLE__
#  error Apple OSX only!
#endif  // __APPLE__
 
// #define __CARBONSOUND__
 
#include "GHOST_System.hh"
 
class GHOST_EventCursor;
class GHOST_EventKey;
class GHOST_EventWindow;
class GHOST_WindowCocoa;
 
class GHOST_SystemCocoa : public GHOST_System {
 public:
  GHOST_SystemCocoa();
 
  ~GHOST_SystemCocoa() override;
 
  /***************************************************************************************
   * Time(r) functionality.
   ***************************************************************************************/
 
  uint64_t getMilliSeconds() const override;
 
  /***************************************************************************************
   * Display/window management functionality.
   ***************************************************************************************/
 
  uint8_t getNumDisplays() const override;
 
  void getMainDisplayDimensions(uint32_t &width, uint32_t &height) const override;
 
  void getAllDisplayDimensions(uint32_t &width, uint32_t &height) const override;
 
  GHOST_IWindow *createWindow(const char *title,
                              int32_t left,
                              int32_t top,
                              uint32_t width,
                              uint32_t height,
                              GHOST_TWindowState state,
                              GHOST_GPUSettings gpuSettings,
                              const bool exclusive = false,
                              const bool is_dialog = false,
                              const GHOST_IWindow *parentWindow = nullptr) override;
 
  GHOST_IContext *createOffscreenContext(GHOST_GPUSettings gpuSettings) override;
 
  GHOST_TSuccess disposeContext(GHOST_IContext *context) override;
 
  GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y) override;
 
  /***************************************************************************************
   * Event management functionality.
   ***************************************************************************************/
 
  bool processEvents(bool waitForEvent) override;
 
  void handleQuitRequest();
 
  bool handleOpenDocumentRequest(void *filepathStr);
 
  GHOST_TSuccess handleDraggingEvent(GHOST_TEventType eventType,
                                     GHOST_TDragnDropTypes draggedObjectType,
                                     GHOST_WindowCocoa *window,
                                     int mouseX,
                                     int mouseY,
                                     void *data);
 
  /***************************************************************************************
   * Cursor management functionality.
   ***************************************************************************************/
 
  GHOST_TSuccess getCursorPosition(int32_t &x, int32_t &y) const override;
 
  GHOST_TSuccess setCursorPosition(int32_t x, int32_t y) override;
 
  GHOST_TSuccess getPixelAtCursor(float r_color[3]) const override;
 
  /***************************************************************************************
   * Access to mouse button and keyboard states.
   ***************************************************************************************/
 
  GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys &keys) const override;
 
  GHOST_TSuccess getButtons(GHOST_Buttons &buttons) const override;
 
  GHOST_TCapabilityFlag getCapabilities() const override;
 
  /***************************************************************************************
   * Clipboard get / set.
   ***************************************************************************************/
 
  char *getClipboard(bool selection) const override;
 
  void putClipboard(const char *buffer, bool selection) const override;
 
  GHOST_TSuccess hasClipboardImage() const override;
 
  uint *getClipboardImage(int *r_width, int *r_height) const override;
 
  GHOST_TSuccess putClipboardImage(uint *rgba, int width, int height) const override;
 
  GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa *window);
 
  GHOST_TSuccess handleApplicationBecomeActiveEvent();
 
  bool hasDialogWindow();
 
  void notifyExternalEventProcessed();
 
  bool setConsoleWindowState(GHOST_TConsoleWindowState /*action*/) override
  {
    return false;
  }
 
  GHOST_TSuccess handleTabletEvent(void *eventPtr, short eventType);
  bool handleTabletEvent(void *eventPtr);
 
  GHOST_TSuccess handleMouseEvent(void *eventPtr);
 
  GHOST_TSuccess handleKeyEvent(void *eventPtr);
 
  GHOST_TSuccess showMessageBox(const char *title,
                                const char *message,
                                const char *help_label,
                                const char *continue_label,
                                const char *link,
                                GHOST_DialogOptions dialog_options) const override;
 
 protected:
  GHOST_TSuccess init() override;
 
  GHOST_TSuccess setMouseCursorPosition(int32_t x, int32_t y);
 
  bool m_outsideLoopEventProcessed;
 
  bool m_needDelayedApplicationBecomeActiveEventProcessing;
 
  uint32_t m_modifierMask;
 
  bool m_ignoreWindowSizedMessages;
 
  bool m_ignoreMomentumScroll;
  bool m_multiTouchScroll;
  double m_last_warp_timestamp;
};