intern/ghost/GHOST_IWindow.h

   1 /**
   2  * $Id$
   3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version. The Blender
   9  * Foundation also sells licenses for use in proprietary software under
  10  * the Blender License.  See http://www.blender.org/BL/ for information
  11  * about this.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  30  */
  31
  32 /**
  33
  34  * $Id$
  35  * Copyright (C) 2001 NaN Technologies B.V.
  36  * @author      Maarten Gribnau
  37  * @date        May 31, 2001
  38  */
  39
  40 #ifndef _GHOST_IWINDOW_H_
  41 #define _GHOST_IWINDOW_H_
  42
  43 #include "STR_String.h"
  44 #include "GHOST_Rect.h"
  45 #include "GHOST_Types.h"
  46
  47
  48 /**
  49  * Interface for GHOST windows.
  50  * Dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
  51  * @author      Maarten Gribnau
  52  * @date        May 31, 2001
  53  */
  54
  55 class GHOST_IWindow
  56 {
  57 public:
  58         /**
  59          * Destructor.
  60          */
  61         virtual ~GHOST_IWindow()
  62         {
  63         }
  64
  65         /**
  66          * Returns indication as to whether the window is valid.
  67          * @return The validity of the window.
  68          */
  69         virtual bool getValid() const = 0;
  70
  71         /**
  72          * Returns the type of drawing context used in this window.
  73          * @return The current type of drawing context.
  74          */
  75         inline virtual GHOST_TDrawingContextType getDrawingContextType() = 0;
  76
  77         /**
  78          * Tries to install a rendering context in this window.
  79          * @param type  The type of rendering context installed.
  80          * @return Indication as to whether installation has succeeded.
  81          */
  82         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
  83
  84         /**
  85          * Sets the title displayed in the title bar.
  86          * @param title The title to display in the title bar.
  87          */
  88         virtual void setTitle(const STR_String& title) = 0;
  89
  90         /**
  91          * Returns the title displayed in the title bar.
  92          * @param title The title displayed in the title bar.
  93          */
  94         virtual void getTitle(STR_String& title) const = 0;
  95
  96         /**
  97          * Returns the window rectangle dimensions.
  98          * These are screen coordinates.
  99          * @param bounds The bounding rectangle of the window.
 100          */
 101         virtual void getWindowBounds(GHOST_Rect& bounds) const = 0;
 102
 103         /**
 104          * Returns the client rectangle dimensions.
 105          * The left and top members of the rectangle are always zero.
 106          * @param bounds The bounding rectangle of the client area of the window.
 107          */
 108         virtual void getClientBounds(GHOST_Rect& bounds) const = 0;
 109
 110         /**
 111          * Resizes client rectangle width.
 112          * @param width The new width of the client area of the window.
 113          */
 114         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
 115
 116         /**
 117          * Resizes client rectangle height.
 118          * @param height The new height of the client area of the window.
 119          */
 120         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
 121
 122         /**
 123          * Resizes client rectangle.
 124          * @param width         The new width of the client area of the window.
 125          * @param height        The new height of the client area of the window.
 126          */
 127         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
 128
 129         /**
 130          * Converts a point in screen coordinates to client rectangle coordinates
 131          * @param inX   The x-coordinate on the screen.
 132          * @param inY   The y-coordinate on the screen.
 133          * @param outX  The x-coordinate in the client rectangle.
 134          * @param outY  The y-coordinate in the client rectangle.
 135          */
 136         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
 137
 138         /**
 139          * Converts a point in screen coordinates to client rectangle coordinates
 140          * @param inX   The x-coordinate in the client rectangle.
 141          * @param inY   The y-coordinate in the client rectangle.
 142          * @param outX  The x-coordinate on the screen.
 143          * @param outY  The y-coordinate on the screen.
 144          */
 145         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
 146
 147         /**
 148          * Returns the state of the window (normal, minimized, maximized).
 149          * @return The state of the window.
 150          */
 151         virtual GHOST_TWindowState getState() const = 0;
 152
 153         /**
 154          * Sets the state of the window (normal, minimized, maximized).
 155          * @param state The state of the window.
 156          * @return Indication of success.
 157          */
 158         virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
 159
 160         /**
 161          * Sets the order of the window (bottom, top).
 162          * @param order The order of the window.
 163          * @return Indication of success.
 164          */
 165         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
 166
 167         /**
 168          * Swaps front and back buffers of a window.
 169          * @return      A boolean success indicator.
 170          */
 171         virtual GHOST_TSuccess swapBuffers() = 0;
 172
 173         /**
 174          * Activates the drawing context of this window.
 175          * @return      A boolean success indicator.
 176          */
 177         virtual GHOST_TSuccess activateDrawingContext() = 0;
 178
 179         /**
 180          * Invalidates the contents of this window.
 181          * @return Indication of success.
 182          */
 183         virtual GHOST_TSuccess invalidate() = 0;
 184
 185         /**
 186          * Returns the window user data.
 187          * @return The window user data.
 188          */
 189         inline virtual GHOST_TUserDataPtr getUserData() const = 0;
 190
 191         /**
 192          * Changes the window user data.
 193          * @param data The window user data.
 194          */
 195         virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
 196
 197         /***************************************************************************************
 198          ** Cursor management functionality
 199          ***************************************************************************************/
 200
 201         /**
 202          * Returns the current cursor shape.
 203          * @return      The current cursor shape.
 204          */
 205         virtual GHOST_TStandardCursor getCursorShape() const = 0;
 206
 207         /**
 208          * Set the shape of the cursor.
 209          * @param       cursor  The new cursor shape type id.
 210          * @return      Indication of success.
 211          */
 212         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
 213
 214         /**
 215          * Set the shape of the cursor to a custom cursor.
 216          * @param       bitmap  The bitmap data for the cursor.
 217          * @param       mask    The mask data for the cursor.
 218          * @param       hotX    The X coordinate of the cursor hotspot.
 219          * @param       hotY    The Y coordinate of the cursor hotspot.
 220          * @return      Indication of success.
 221          */
 222         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2],
 223                                                                                                 GHOST_TUns8 mask[16][2],
 224                                                                                                 int hotX,
 225                                                                                                 int hotY) = 0;
 226
 227         /**
 228          * Returns the visibility state of the cursor.
 229          * @return      The visibility state of the cursor.
 230          */
 231         virtual bool getCursorVisibility() const = 0;
 232
 233         /**
 234          * Shows or hides the cursor.
 235          * @param       visible The new visibility state of the cursor.
 236          * @return      Indication of success.
 237          */
 238         virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
 239 };
 240
 241 #endif // _GHOST_IWINDOW_H_
 242