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