intern/ghost/intern/GHOST_WindowWin32.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  * @file        GHOST_WindowWin32.h
  33  * Declaration of GHOST_WindowWin32 class.
  34  */
  35
  36 #ifndef _GHOST_WINDOW_WIN32_H_
  37 #define _GHOST_WINDOW_WIN32_H_
  38
  39 #ifndef WIN32
  40 #error WIN32 only!
  41 #endif // WIN32
  42
  43 #include "GHOST_Window.h"
  44
  45 #include <windows.h>
  46
  47
  48 /**
  49  * GHOST window on M$ Windows OSs.
  50  * @author      Maarten Gribnau
  51  * @date        May 10, 2001
  52  */
  53 class GHOST_WindowWin32 : public GHOST_Window {
  54 public:
  55         /**
  56          * Constructor.
  57          * Creates a new window and opens it.
  58          * To check if the window was created properly, use the getValid() method.
  59          * @param title         The text shown in the title bar of the window.
  60          * @param left          The coordinate of the left edge of the window.
  61          * @param top           The coordinate of the top edge of the window.
  62          * @param width         The width the window.
  63          * @param height        The height the window.
  64          * @param state         The state the window is initially opened with.
  65          * @param type          The type of drawing context installed in this window.
  66          * @param stereoVisual  Stereo visual for quad buffered stereo.
  67          */
  68         GHOST_WindowWin32(
  69                 const STR_String& title,
  70                 GHOST_TInt32 left,
  71                 GHOST_TInt32 top,
  72                 GHOST_TUns32 width,
  73                 GHOST_TUns32 height,
  74                 GHOST_TWindowState state,
  75                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
  76                 const bool stereoVisual = false
  77         );
  78
  79         /**
  80          * Destructor.
  81          * Closes the window and disposes resources allocated.
  82          */
  83         virtual ~GHOST_WindowWin32();
  84
  85         /**
  86          * Returns indication as to whether the window is valid.
  87          * @return The validity of the window.
  88          */
  89         virtual bool getValid() const;
  90
  91         /**
  92          * Sets the title displayed in the title bar.
  93          * @param title The title to display in the title bar.
  94          */
  95         virtual void setTitle(const STR_String& title);
  96
  97         /**
  98          * Returns the title displayed in the title bar.
  99          * @param title The title displayed in the title bar.
 100          */
 101         virtual void getTitle(STR_String& title) const;
 102
 103         /**
 104          * Returns the window rectangle dimensions.
 105          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
 106          * @param bounds The bounding rectangle of the window.
 107          */
 108         virtual void getWindowBounds(GHOST_Rect& bounds) const;
 109
 110         /**
 111          * Returns the client rectangle dimensions.
 112          * The left and top members of the rectangle are always zero.
 113          * @param bounds The bounding rectangle of the cleient area of the window.
 114          */
 115         virtual void getClientBounds(GHOST_Rect& bounds) const;
 116
 117         /**
 118          * Resizes client rectangle width.
 119          * @param width The new width of the client area of the window.
 120          */
 121         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 122
 123         /**
 124          * Resizes client rectangle height.
 125          * @param height The new height of the client area of the window.
 126          */
 127         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 128
 129         /**
 130          * Resizes client rectangle.
 131          * @param width         The new width of the client area of the window.
 132          * @param height        The new height of the client area of the window.
 133          */
 134         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 135
 136         /**
 137          * Returns the state of the window (normal, minimized, maximized).
 138          * @return The state of the window.
 139          */
 140         virtual GHOST_TWindowState getState() const;
 141
 142         /**
 143          * Converts a point in screen coordinates to client rectangle coordinates
 144          * @param inX   The x-coordinate on the screen.
 145          * @param inY   The y-coordinate on the screen.
 146          * @param outX  The x-coordinate in the client rectangle.
 147          * @param outY  The y-coordinate in the client rectangle.
 148          */
 149         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 150
 151         /**
 152          * Converts a point in screen coordinates to client rectangle coordinates
 153          * @param inX   The x-coordinate in the client rectangle.
 154          * @param inY   The y-coordinate in the client rectangle.
 155          * @param outX  The x-coordinate on the screen.
 156          * @param outY  The y-coordinate on the screen.
 157          */
 158         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 159
 160         /**
 161          * Sets the state of the window (normal, minimized, maximized).
 162          * @param state The state of the window.
 163          * @return Indication of success.
 164          */
 165         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 166
 167         /**
 168          * Sets the order of the window (bottom, top).
 169          * @param order The order of the window.
 170          * @return Indication of success.
 171          */
 172         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 173
 174         /**
 175          * Swaps front and back buffers of a window.
 176          * @return Indication of success.
 177          */
 178         virtual GHOST_TSuccess swapBuffers();
 179
 180         /**
 181          * Activates the drawing context of this window.
 182          * @return Indication of success.
 183          */
 184         virtual GHOST_TSuccess activateDrawingContext();
 185
 186         /**
 187          * Invalidates the contents of this window.
 188          */
 189         virtual GHOST_TSuccess invalidate();
 190
 191         /**
 192          * Returns the name of the window class.
 193          * @return The name of the window class.
 194          */
 195         static LPCSTR getWindowClassName() { return s_windowClassName; }
 196
 197         /**
 198          * Register a mouse click event (should be called
 199          * for any real button press, controls mouse
 200          * capturing).
 201          *
 202          * @param press True the event was a button press.
 203          */
 204         void registerMouseClickEvent(bool press);
 205
 206         /**
 207          * Inform the window that it has lost mouse capture,
 208          * called in response to native window system messages.
 209          */
 210         void lostMouseCapture();
 211
 212         /**
 213          * Loads the windows equivalent of a standard GHOST cursor.
 214          * @param visible               Flag for cursor visibility.
 215          * @param cursorShape   The cursor shape.
 216          */
 217         void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;
 218
 219
 220 protected:
 221         /**
 222          * Tries to install a rendering context in this window.
 223          * @param type  The type of rendering context installed.
 224          * @return Indication of success.
 225          */
 226         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
 227
 228         /**
 229          * Removes the current drawing context.
 230          * @return Indication of success.
 231          */
 232         virtual GHOST_TSuccess removeDrawingContext();
 233
 234         /**
 235          * Sets the cursor visibility on the window using
 236          * native window system calls.
 237          */
 238         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
 239
 240         /**
 241          * Sets the cursor shape on the window using
 242          * native window system calls.
 243          */
 244         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
 245
 246         /**
 247          * Sets the cursor shape on the window using
 248          * native window system calls.
 249          */
 250         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
 251
 252         virtual setWindowCustomCursorShape(
 253                 GHOST_TUns8 *bitmap,
 254                 GHOST_TUns8 *mask,
 255                 int sizex,
 256                 int sizey,
 257                 int hotX,
 258                 int hotY,
 259                 int fg_color,
 260                 int bg_color
 261         );
 262
 263         /** Window handle. */
 264         HWND m_hWnd;
 265         /** Device context handle. */
 266         HDC m_hDC;
 267         /** OpenGL rendering context. */
 268         HGLRC m_hGlRc;
 269         /** The first created OpenGL context (for sharing display lists) */
 270         static HGLRC s_firsthGLRc;
 271         /** Flag for if window has captured the mouse */
 272         bool m_hasMouseCaptured;
 273         /** Count of number of pressed buttons */
 274         int m_nPressedButtons;
 275         /** HCURSOR structure of the custom cursor */
 276         HCURSOR m_customCursor;
 277
 278         static LPCSTR s_windowClassName;
 279         static const int s_maxTitleLength;
 280 };
 281
 282 #endif // _GHOST_WINDOW_WIN32_H_
 283