GHOST_IWindow.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#include "GHOST_Rect.h"
#include "GHOST_Types.h"
 
#include <stdlib.h>
#include <string>
 
class GHOST_IWindow {
 public:
  virtual ~GHOST_IWindow()
  {
  }
 
  virtual bool getValid() const = 0;
 
  virtual void *getOSWindow() const = 0;
 
  virtual GHOST_TDrawingContextType getDrawingContextType() = 0;
 
  virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
 
  virtual void setTitle(const char *title) = 0;
 
  virtual std::string getTitle() const = 0;
 
  virtual void getWindowBounds(GHOST_Rect &bounds) const = 0;
 
  virtual void getClientBounds(GHOST_Rect &bounds) const = 0;
 
  virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
 
  virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
 
  virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
 
  virtual void screenToClient(GHOST_TInt32 inX,
                              GHOST_TInt32 inY,
                              GHOST_TInt32 &outX,
                              GHOST_TInt32 &outY) const = 0;
 
  virtual void clientToScreen(GHOST_TInt32 inX,
                              GHOST_TInt32 inY,
                              GHOST_TInt32 &outX,
                              GHOST_TInt32 &outY) const = 0;
 
  virtual void setAcceptDragOperation(bool canAccept) = 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 isUnsavedChanges) = 0;
 
  virtual bool getModifiedState() = 0;
 
  virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
 
  virtual GHOST_TSuccess swapBuffers() = 0;
 
  virtual GHOST_TSuccess setSwapInterval(int interval) = 0;
 
  virtual GHOST_TSuccess getSwapInterval(int &intervalOut) = 0;
 
  virtual GHOST_TSuccess activateDrawingContext() = 0;
 
  virtual unsigned int getDefaultFramebuffer() = 0;
 
  virtual GHOST_TSuccess invalidate() = 0;
 
  virtual GHOST_TUserDataPtr getUserData() const = 0;
 
  virtual void setUserData(const GHOST_TUserDataPtr userData) = 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 cursorShape) = 0;
 
  virtual GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor cursorShape) = 0;
 
  virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap,
                                              GHOST_TUns8 *mask,
                                              int sizex,
                                              int sizey,
                                              int hotX,
                                              int hotY,
                                              bool canInvertColor) = 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*/,
                                       GHOST_TInt32 /*mouse_ungrab_xy*/[2])
  {
    return GHOST_kSuccess;
  }
 
  virtual GHOST_TSuccess beginFullScreen() const = 0;
  virtual GHOST_TSuccess endFullScreen() const = 0;
 
  virtual float getNativePixelSize(void) = 0;
 
  virtual GHOST_TUns16 getDPIHint() = 0;
 
#ifdef WITH_INPUT_IME
  virtual void beginIME(
      GHOST_TInt32 x, GHOST_TInt32 y, GHOST_TInt32 w, GHOST_TInt32 h, int completed) = 0;
 
  virtual void endIME() = 0;
#endif /* WITH_INPUT_IME */
 
#ifdef WITH_CXX_GUARDEDALLOC
  MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_IWindow")
#endif
};