merge with trunk at r27259 and commit of a patch by anthony jones to fix msvc (though...
[blender-staging.git] / intern / ghost / intern / GHOST_WindowCocoa.h
1 /**
2  * $Id: GHOST_WindowCocoa.h 23789 2009-10-12 16:51:36Z damien78 $
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 @class CocoaWindow;
44
45 class GHOST_SystemCocoa;
46
47 /**
48  * Window on Mac OSX/Cocoa.
49  * Carbon windows have a size widget in the lower right corner of the window.
50  * To force it to be visible, the height of the client rectangle is reduced so
51  * that applications do not draw in that area. GHOST will manage that area
52  * which is called the gutter.
53  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
54  * OpenGL drawing outside the reduced client rectangle.
55  * @author      Maarten Gribnau
56  * @date        May 23, 2001
57  */
58 class GHOST_WindowCocoa : public GHOST_Window {
59 public:
60         /**
61          * Constructor.
62          * Creates a new window and opens it.
63          * To check if the window was created properly, use the getValid() method.
64          * @param systemCocoa           The associated system class to forward events to
65          * @param title                         The text shown in the title bar of the window.
66          * @param left                          The coordinate of the left edge of the window.
67          * @param top                           The coordinate of the top edge of the window.
68          * @param width                         The width the window.
69          * @param height                        The height the window.
70          * @param state                         The state the window is initially opened with.
71          * @param type                          The type of drawing context installed in this window.
72          * @param stereoVisual          Stereo visual for quad buffered stereo.
73          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
74          */
75         GHOST_WindowCocoa(
76                 GHOST_SystemCocoa *systemCocoa,
77                 const STR_String& title,
78                 GHOST_TInt32 left,
79                 GHOST_TInt32 top,
80                 GHOST_TUns32 width,
81                 GHOST_TUns32 height,
82                 GHOST_TWindowState state,
83                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
84                 const bool stereoVisual = false,
85                 const GHOST_TUns16 numOfAASamples = 0
86         );
87
88         /**
89          * Destructor.
90          * Closes the window and disposes resources allocated.
91          */
92         virtual ~GHOST_WindowCocoa();
93
94         /**
95          * Returns indication as to whether the window is valid.
96          * @return The validity of the window.
97          */
98         virtual bool getValid() const;
99         
100         /**
101          * Returns the associated NSWindow object
102          * @return The associated NSWindow object
103          */
104         virtual void* getOSWindow() const;
105
106         /**
107          * Sets the title displayed in the title bar.
108          * @param title The title to display in the title bar.
109          */
110         virtual void setTitle(const STR_String& title);
111
112         /**
113          * Returns the title displayed in the title bar.
114          * @param title The title displayed in the title bar.
115          */
116         virtual void getTitle(STR_String& title) const;
117
118         /**
119          * Returns the window rectangle dimensions.
120          * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
121          * @param bounds The bounding rectangle of the window.
122          */
123         virtual void getWindowBounds(GHOST_Rect& bounds) const;
124         
125         /**
126          * Returns the client rectangle dimensions.
127          * The left and top members of the rectangle are always zero.
128          * @param bounds The bounding rectangle of the cleient area of the window.
129          */
130         virtual void getClientBounds(GHOST_Rect& bounds) const;
131
132         /**
133          * Resizes client rectangle width.
134          * @param width The new width of the client area of the window.
135          */
136         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
137
138         /**
139          * Resizes client rectangle height.
140          * @param height The new height of the client area of the window.
141          */
142         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
143
144         /**
145          * Resizes client rectangle.
146          * @param width         The new width of the client area of the window.
147          * @param height        The new height of the client area of the window.
148          */
149         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
150
151         /**
152          * Returns the state of the window (normal, minimized, maximized).
153          * @return The state of the window.
154          */
155         virtual GHOST_TWindowState getState() const;
156
157         /**
158          * Sets the window "modified" status, indicating unsaved changes
159          * @param isUnsavedChanges Unsaved changes or not
160          * @return Indication of success.
161          */
162         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
163         
164         /**
165          * Converts a point in screen coordinates to client rectangle coordinates
166          * @param inX   The x-coordinate on the screen.
167          * @param inY   The y-coordinate on the screen.
168          * @param outX  The x-coordinate in the client rectangle.
169          * @param outY  The y-coordinate in the client rectangle.
170          */
171         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
172
173         /**
174          * Converts a point in screen coordinates to client rectangle coordinates
175          * @param inX   The x-coordinate in the client rectangle.
176          * @param inY   The y-coordinate in the client rectangle.
177          * @param outX  The x-coordinate on the screen.
178          * @param outY  The y-coordinate on the screen.
179          */
180         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
181
182         /**
183          * Gets the screen the window is displayed in
184          * @return The NSScreen object
185          */
186         NSScreen* getScreen();
187         
188         /**
189          * Sets the state of the window (normal, minimized, maximized).
190          * @param state The state of the window.
191          * @return Indication of success.
192          */
193         virtual GHOST_TSuccess setState(GHOST_TWindowState state);
194
195         /**
196          * Sets the order of the window (bottom, top).
197          * @param order The order of the window.
198          * @return Indication of success.
199          */
200         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
201
202         /**
203          * Swaps front and back buffers of a window.
204          * @return      A boolean success indicator.
205          */
206         virtual GHOST_TSuccess swapBuffers();
207
208         /**
209          * Updates the drawing context of this window. Needed
210          * whenever the window is changed.
211          * @return Indication of success.
212          */
213         GHOST_TSuccess updateDrawingContext();
214
215         /**
216          * Activates the drawing context of this window.
217          * @return      A boolean success indicator.
218          */
219         virtual GHOST_TSuccess activateDrawingContext();
220
221         virtual void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
222     
223
224         const GHOST_TabletData* GetTabletData()
225         { return &m_tablet; }
226
227         GHOST_TabletData& GetCocoaTabletData()
228         { return m_tablet; }
229 protected:
230         /**
231          * Tries to install a rendering context in this window.
232          * @param type  The type of rendering context installed.
233          * @return Indication as to whether installation has succeeded.
234          */
235         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
236
237         /**
238          * Removes the current drawing context.
239          * @return Indication as to whether removal has succeeded.
240          */
241         virtual GHOST_TSuccess removeDrawingContext();
242     
243         /**
244          * Invalidates the contents of this window.
245          * @return Indication of success.
246          */
247         virtual GHOST_TSuccess invalidate();
248
249         /**
250          * Sets the cursor visibility on the window using
251          * native window system calls.
252          */
253         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
254         
255         /**
256          * Sets the cursor grab on the window using
257          * native window system calls.
258          */
259         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
260                 
261         /**
262          * Sets the cursor shape on the window using
263          * native window system calls.
264          */
265         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
266
267         /**
268          * Sets the cursor shape on the window using
269          * native window system calls.
270          */
271         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask,
272                                         int sizex, int sizey, int hotX, int hotY, int fg_color, int bg_color);
273                                         
274         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
275     
276         /** The window containing the OpenGL view */
277     CocoaWindow *m_window;
278         
279         /** The openGL view */
280         NSOpenGLView *m_openGLView; 
281     
282         /** The opgnGL drawing context */
283         NSOpenGLContext *m_openGLContext;
284         
285         /** The mother SystemCocoa class to send events */
286         GHOST_SystemCocoa *m_systemCocoa;
287                         
288         /** The first created OpenGL context (for sharing display lists) */
289         static NSOpenGLContext *s_firstOpenGLcontext;
290         
291         NSCursor*       m_customCursor;
292
293         GHOST_TabletData m_tablet;
294     
295     /**
296      * The width/height of the size rectangle in the lower right corner of a 
297      * Mac/Carbon window. This is also the height of the gutter area.
298      */
299 #ifdef GHOST_DRAW_CARBON_GUTTER
300     static const GHOST_TInt32 s_sizeRectSize;
301 #endif // GHOST_DRAW_CARBON_GUTTER
302 };
303
304 #endif // _GHOST_WINDOW_COCOA_H_
305