intern/ghost/intern/GHOST_WindowCocoa.h

   1 /**
   2  * $Id$
   3  * ***** BEGIN GPL 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.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software Foundation,
  17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18  *
  19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  20  * All rights reserved.
  21  *
  22  * The Original Code is: all of this file.
  23  *
  24  * Contributor(s): none yet.
  25  *
  26  * ***** END GPL LICENSE BLOCK *****
  27  */
  28 /**
  29  * @file        GHOST_WindowCocoa.h
  30  * Declaration of GHOST_WindowCocoa class.
  31  */
  32
  33 #ifndef _GHOST_WINDOW_COCOA_H_
  34 #define _GHOST_WINDOW_COCOA_H_
  35
  36 #ifndef __APPLE__
  37 #error Apple OSX only!
  38 #endif // __APPLE__
  39
  40 #include "GHOST_Window.h"
  41 #include "STR_String.h"
  42
  43 #include <AGL/agl.h>
  44
  45
  46 /**
  47  * Window on Mac OSX/Cocoa.
  48  * Carbon windows have a size widget in the lower right corner of the window.
  49  * To force it to be visible, the height of the client rectangle is reduced so
  50  * that applications do not draw in that area. GHOST will manage that area
  51  * which is called the gutter.
  52  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
  53  * OpenGL drawing outside the reduced client rectangle.
  54  * @author      Maarten Gribnau
  55  * @date        May 23, 2001
  56  */
  57 class GHOST_WindowCocoa : public GHOST_Window {
  58 public:
  59         /**
  60          * Constructor.
  61          * Creates a new window and opens it.
  62          * To check if the window was created properly, use the getValid() method.
  63          * @param title         The text shown in the title bar of the window.
  64          * @param left          The coordinate of the left edge of the window.
  65          * @param top           The coordinate of the top edge of the window.
  66          * @param width         The width the window.
  67          * @param height        The height the window.
  68          * @param state         The state the window is initially opened with.
  69          * @param type          The type of drawing context installed in this window.
  70          * @param stereoVisual  Stereo visual for quad buffered stereo.
  71          */
  72         GHOST_WindowCocoa(
  73                 const STR_String& title,
  74                 GHOST_TInt32 left,
  75                 GHOST_TInt32 top,
  76                 GHOST_TUns32 width,
  77                 GHOST_TUns32 height,
  78                 GHOST_TWindowState state,
  79                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
  80                 const bool stereoVisual = false
  81         );
  82
  83         /**
  84          * Destructor.
  85          * Closes the window and disposes resources allocated.
  86          */
  87         virtual ~GHOST_WindowCocoa();
  88
  89         /**
  90          * Returns indication as to whether the window is valid.
  91          * @return The validity of the window.
  92          */
  93         virtual bool getValid() const;
  94
  95         /**
  96          * Sets the title displayed in the title bar.
  97          * @param title The title to display in the title bar.
  98          */
  99         virtual void setTitle(const STR_String& title);
 100
 101         /**
 102          * Returns the title displayed in the title bar.
 103          * @param title The title displayed in the title bar.
 104          */
 105         virtual void getTitle(STR_String& title) const;
 106
 107         /**
 108          * Returns the window rectangle dimensions.
 109          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.
 110          * @param bounds The bounding rectangle of the window.
 111          */
 112         virtual void getWindowBounds(GHOST_Rect& bounds) const;
 113
 114         /**
 115          * Returns the client rectangle dimensions.
 116          * The left and top members of the rectangle are always zero.
 117          * @param bounds The bounding rectangle of the cleient area of the window.
 118          */
 119         virtual void getClientBounds(GHOST_Rect& bounds) const;
 120
 121         /**
 122          * Resizes client rectangle width.
 123          * @param width The new width of the client area of the window.
 124          */
 125         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 126
 127         /**
 128          * Resizes client rectangle height.
 129          * @param height The new height of the client area of the window.
 130          */
 131         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 132
 133         /**
 134          * Resizes client rectangle.
 135          * @param width         The new width of the client area of the window.
 136          * @param height        The new height of the client area of the window.
 137          */
 138         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 139
 140         /**
 141          * Returns the state of the window (normal, minimized, maximized).
 142          * @return The state of the window.
 143          */
 144         virtual GHOST_TWindowState getState() const;
 145
 146         /**
 147          * Converts a point in screen coordinates to client rectangle coordinates
 148          * @param inX   The x-coordinate on the screen.
 149          * @param inY   The y-coordinate on the screen.
 150          * @param outX  The x-coordinate in the client rectangle.
 151          * @param outY  The y-coordinate in the client rectangle.
 152          */
 153         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 154
 155         /**
 156          * Converts a point in screen coordinates to client rectangle coordinates
 157          * @param inX   The x-coordinate in the client rectangle.
 158          * @param inY   The y-coordinate in the client rectangle.
 159          * @param outX  The x-coordinate on the screen.
 160          * @param outY  The y-coordinate on the screen.
 161          */
 162         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 163
 164         /**
 165          * Sets the state of the window (normal, minimized, maximized).
 166          * @param state The state of the window.
 167          * @return Indication of success.
 168          */
 169         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 170
 171         /**
 172          * Sets the order of the window (bottom, top).
 173          * @param order The order of the window.
 174          * @return Indication of success.
 175          */
 176         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 177
 178         /**
 179          * Swaps front and back buffers of a window.
 180          * @return      A boolean success indicator.
 181          */
 182         virtual GHOST_TSuccess swapBuffers();
 183
 184         /**
 185          * Updates the drawing context of this window. Needed
 186          * whenever the window is changed.
 187          * @return Indication of success.
 188          */
 189         GHOST_TSuccess updateDrawingContext();
 190
 191         /**
 192          * Activates the drawing context of this window.
 193          * @return      A boolean success indicator.
 194          */
 195         virtual GHOST_TSuccess activateDrawingContext();
 196
 197         virtual void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
 198
 199     /**
 200      * Returns the dirty state of the window when in full-screen mode.
 201      * @return Whether it is dirty.
 202      */
 203     virtual bool getFullScreenDirty();
 204
 205                 /* accessor for fullscreen window */
 206         virtual void setMac_windowState(short value);
 207         virtual short getMac_windowState();
 208
 209
 210         const GHOST_TabletData* GetTabletData()
 211         { return &m_tablet; }
 212
 213         GHOST_TabletData& GetCocoaTabletData()
 214         { return m_tablet; }
 215 protected:
 216         /**
 217          * Tries to install a rendering context in this window.
 218          * @param type  The type of rendering context installed.
 219          * @return Indication as to whether installation has succeeded.
 220          */
 221         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
 222
 223         /**
 224          * Removes the current drawing context.
 225          * @return Indication as to whether removal has succeeded.
 226          */
 227         virtual GHOST_TSuccess removeDrawingContext();
 228
 229         /**
 230          * Invalidates the contents of this window.
 231          * @return Indication of success.
 232          */
 233         virtual GHOST_TSuccess invalidate();
 234
 235         /**
 236          * Sets the cursor visibility on the window using
 237          * native window system calls.
 238          */
 239         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
 240
 241         /**
 242          * Sets the cursor shape on the window using
 243          * native window system calls.
 244          */
 245         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
 246
 247         /**
 248          * Sets the cursor shape on the window using
 249          * native window system calls.
 250          */
 251         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask,
 252                                         int sizex, int sizey, int hotX, int hotY, int fg_color, int bg_color);
 253
 254         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
 255
 256     /**
 257      * Converts a string object to a Mac Pascal string.
 258      * @param in        The string object to be converted.
 259      * @param out       The converted string.
 260      */
 261     virtual void gen2mac(const STR_String& in, Str255 out) const;
 262
 263     /**
 264      * Converts a Mac Pascal string to a string object.
 265      * @param in        The string to be converted.
 266      * @param out       The converted string object.
 267      */
 268     virtual void mac2gen(const Str255 in, STR_String& out) const;
 269
 270     WindowRef m_windowRef;
 271     CGrafPtr m_grafPtr;
 272     AGLContext m_aglCtx;
 273
 274         /** The first created OpenGL context (for sharing display lists) */
 275         static AGLContext s_firstaglCtx;
 276
 277         Cursor* m_customCursor;
 278
 279         GHOST_TabletData m_tablet;
 280
 281     /** When running in full-screen this tells whether to refresh the window. */
 282     bool m_fullScreenDirty;
 283
 284         /** specific MacOs X full screen window setting as we use partially system mechanism
 285             values :      0       not maximizable default
 286                               1       normal state
 287                                           2               maximized state
 288
 289              this will be reworked when rebuilding GHOST carbon to use new OS X apis
 290                 in order to be unified with GHOST fullscreen/maximised settings
 291
 292                  (lukep)
 293     **/
 294
 295         short mac_windowState;
 296
 297
 298     /**
 299      * The width/height of the size rectangle in the lower right corner of a
 300      * Mac/Carbon window. This is also the height of the gutter area.
 301      */
 302 #ifdef GHOST_DRAW_CARBON_GUTTER
 303     static const GHOST_TInt32 s_sizeRectSize;
 304 #endif // GHOST_DRAW_CARBON_GUTTER
 305 };
 306
 307 #endif // _GHOST_WINDOW_COCOA_H_
 308