GHOST_IWindow.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
 
#include "GHOST_Rect.hh"
#include "GHOST_Types.h"
 
#include <cstdlib>
#include <string>
 
class GHOST_IContext;

class GHOST_IWindow {
 public:
  virtual ~GHOST_IWindow() = default;

  virtual bool getValid() const = 0;

  virtual void *getOSWindow() const = 0;

  virtual GHOST_TDrawingContextType getDrawingContextType() = 0;

  virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;

  virtual GHOST_IContext *getDrawingContext() = 0;

  virtual void setTitle(const char *title) = 0;

  virtual std::string getTitle() const = 0;

  virtual GHOST_TSuccess setPath(const char *filepath) = 0;

  virtual GHOST_TWindowDecorationStyleFlags getWindowDecorationStyleFlags() = 0;

  virtual void setWindowDecorationStyleFlags(GHOST_TWindowDecorationStyleFlags style_flags) = 0;

  virtual void setWindowDecorationStyleSettings(
      GHOST_WindowDecorationStyleSettings decoration_settings) = 0;

  virtual GHOST_TSuccess applyWindowDecorationStyle() = 0;

  virtual void getWindowBounds(GHOST_Rect &bounds) const = 0;

  virtual void getClientBounds(GHOST_Rect &bounds) const = 0;

  virtual GHOST_TSuccess setClientWidth(uint32_t width) = 0;

  virtual GHOST_TSuccess setClientHeight(uint32_t height) = 0;

  virtual GHOST_TSuccess setClientSize(uint32_t width, uint32_t height) = 0;

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

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

  virtual void setAcceptDragOperation(bool can_accept) = 0;

  virtual bool canAcceptDragOperation() const = 0;

  virtual GHOST_TWindowState getState() const = 0;

  virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;

  virtual GHOST_TSuccess setModifiedState(bool is_unsaved_changes) = 0;

  virtual bool getModifiedState() = 0;

  virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;

  virtual GHOST_TSuccess swapBufferAcquire() = 0;

  virtual GHOST_TSuccess swapBufferRelease() = 0;

  virtual GHOST_TSuccess setSwapInterval(int interval) = 0;

  virtual GHOST_TSuccess getSwapInterval(int &interval_out) = 0;

  virtual GHOST_TSuccess activateDrawingContext() = 0;

  virtual unsigned int getDefaultFramebuffer() = 0;
 
#ifdef WITH_VULKAN_BACKEND
  virtual GHOST_TSuccess getVulkanSwapChainFormat(
      GHOST_VulkanSwapChainData *r_swap_chain_data) = 0;
#endif

  virtual GHOST_TSuccess invalidate() = 0;

  virtual GHOST_TUserDataPtr getUserData() const = 0;

  virtual void setUserData(const GHOST_TUserDataPtr user_data) = 0;
 
  virtual bool isDialog() const = 0;
 
  /***************************************************************************************
   * Progress bar functionality
   ***************************************************************************************/

  virtual GHOST_TSuccess setProgressBar(float progress) = 0;

  virtual GHOST_TSuccess endProgressBar() = 0;
 
  /***************************************************************************************
   * Cursor management functionality
   ***************************************************************************************/

  virtual GHOST_TStandardCursor getCursorShape() const = 0;

  virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursor_shape) = 0;

  virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect &bounds) const = 0;
 
  virtual void getCursorGrabState(GHOST_TGrabCursorMode &mode,
                                  GHOST_TAxisFlag &axis_flag,
                                  GHOST_Rect &bounds,
                                  bool &use_software_cursor) = 0;

  virtual bool getCursorGrabUseSoftwareDisplay() = 0;

  virtual GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor cursor_shape) = 0;

  virtual GHOST_TSuccess setCustomCursorShape(const uint8_t *bitmap,
                                              const uint8_t *mask,
                                              const int size[2],
                                              const int hot_spot[2],
                                              bool can_invert_color) = 0;

  virtual GHOST_TSuccess setCustomCursorGenerator(GHOST_CursorGenerator *cursor_generator) = 0;
 
  virtual GHOST_TSuccess getCursorBitmap(GHOST_CursorBitmapRef *bitmap) = 0;

  virtual bool getCursorVisibility() const = 0;

  virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;

  virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode /*mode*/,
                                       GHOST_TAxisFlag /*wrap_axis*/,
                                       GHOST_Rect * /*bounds*/,
                                       int32_t /*mouse_ungrab_xy*/[2])
  {
    return GHOST_kSuccess;
  }

  virtual float getNativePixelSize() = 0;

  virtual uint16_t getDPIHint() = 0;

  virtual GHOST_WindowHDRInfo getHDRInfo() = 0;
 
#ifdef WITH_INPUT_IME
  virtual void beginIME(int32_t x, int32_t y, int32_t w, int32_t h, bool completed) = 0;

  virtual void endIME() = 0;
#endif /* WITH_INPUT_IME */
 
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IWindow")
};