eab5a5b28aaa07aba8cb2d35ac2f34876b43e919
[blender.git] / intern / ghost / intern / GHOST_SystemCocoa.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):      Maarten Gribnau 05/2001
25  *                                      Damien Plisson 09/2009
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 /**
30  * @file        GHOST_SystemCocoa.h
31  * Declaration of GHOST_SystemCocoa class.
32  */
33
34 #ifndef _GHOST_SYSTEM_COCOA_H_
35 #define _GHOST_SYSTEM_COCOA_H_
36
37 #ifndef __APPLE__
38 #error Apple OSX only!
39 #endif // __APPLE__
40
41 //#define __CARBONSOUND__
42
43
44 #include "GHOST_System.h"
45
46 class GHOST_EventCursor;
47 class GHOST_EventKey;
48 class GHOST_EventWindow;
49 class GHOST_WindowCocoa;
50
51
52 class GHOST_SystemCocoa : public GHOST_System {
53 public:
54     /**
55      * Constructor.
56      */
57     GHOST_SystemCocoa();
58     
59     /** 
60      * Destructor.
61      */
62     ~GHOST_SystemCocoa();
63     
64         /***************************************************************************************
65          ** Time(r) functionality
66          ***************************************************************************************/
67
68         /**
69          * Returns the system time.
70          * Returns the number of milliseconds since the start of the system process.
71          * Based on ANSI clock() routine.
72          * @return The number of milliseconds.
73          */
74         virtual GHOST_TUns64 getMilliSeconds() const;
75
76         /***************************************************************************************
77          ** Display/window management functionality
78          ***************************************************************************************/
79
80         /**
81          * Returns the number of displays on this system.
82          * @return The number of displays.
83          */
84         virtual GHOST_TUns8 getNumDisplays() const;
85
86         /**
87          * Returns the dimensions of the main display on this system.
88          * @return The dimension of the main display.
89          */
90         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
91         
92         /**
93          * Create a new window.
94          * The new window is added to the list of windows managed. 
95          * Never explicitly delete the window, use disposeWindow() instead.
96          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
97          * @param       left    The coordinate of the left edge of the window.
98          * @param       top             The coordinate of the top edge of the window.
99          * @param       width   The width the window.
100          * @param       height  The height the window.
101          * @param       state   The state of the window when opened.
102          * @param       type    The type of drawing context installed in this window.
103          * @param       parentWindow    Parent (embedder) window
104          * @return      The new window (or 0 if creation failed).
105          */
106         virtual GHOST_IWindow* createWindow(
107                 const STR_String& title,
108                 GHOST_TInt32 left,
109                 GHOST_TInt32 top,
110                 GHOST_TUns32 width,
111                 GHOST_TUns32 height,
112                 GHOST_TWindowState state,
113                 GHOST_TDrawingContextType type,
114                 const bool stereoVisual,
115                 const GHOST_TEmbedderWindowID parentWindow = 0 
116         );
117         
118         virtual GHOST_TSuccess beginFullScreen(
119                 const GHOST_DisplaySetting& setting, 
120                 GHOST_IWindow** window,
121                 const bool stereoVisual
122         );
123         
124         virtual GHOST_TSuccess endFullScreen( void );
125         
126         /***************************************************************************************
127          ** Event management functionality
128          ***************************************************************************************/
129
130         /**
131          * Gets events from the system and stores them in the queue.
132          * @param waitForEvent Flag to wait for an event (or return immediately).
133          * @return Indication of the presence of events.
134          */
135         virtual bool processEvents(bool waitForEvent);
136         
137         /**
138          * Handle User request to quit, from Menu bar Quit, and Cmd+Q
139          * Display alert panel if changes performed since last save
140          */
141         GHOST_TUns8 handleQuitRequest();
142         
143         /***************************************************************************************
144          ** Cursor management functionality
145          ***************************************************************************************/
146
147         /**
148          * Returns the current location of the cursor (location in screen coordinates)
149          * @param x                     The x-coordinate of the cursor.
150          * @param y                     The y-coordinate of the cursor.
151          * @return                      Indication of success.
152          */
153         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
154
155         /**
156          * Updates the location of the cursor (location in screen coordinates).
157          * @param x                     The x-coordinate of the cursor.
158          * @param y                     The y-coordinate of the cursor.
159          * @return                      Indication of success.
160          */
161         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
162
163         /***************************************************************************************
164          ** Access to mouse button and keyboard states.
165          ***************************************************************************************/
166
167         /**
168          * Returns the state of all modifier keys.
169          * @param keys  The state of all modifier keys (true == pressed).
170          * @return              Indication of success.
171          */
172         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
173
174         /**
175          * Returns the state of the mouse buttons (ouside the message queue).
176          * @param buttons       The state of the buttons.
177          * @return                      Indication of success.
178          */
179         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
180
181         /**
182          * Returns Clipboard data
183          * @param selection             Indicate which buffer to return
184          * @return                              Returns the selected buffer
185          */
186         virtual GHOST_TUns8* getClipboard(bool selection) const;
187         
188         /**
189          * Puts buffer to system clipboard
190          * @param buffer        The buffer to be copied
191          * @param selection     Indicates which buffer to copy too, only used on X11
192          */
193         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
194
195         /**
196      * Handles a window event. Called by GHOST_WindowCocoa window delegate
197      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
198      * @return Indication whether the event was handled. 
199      */
200     GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa* window);
201         
202 protected:
203         /**
204          * Initializes the system.
205          * For now, it justs registers the window class (WNDCLASS).
206          * @return A success value.
207          */
208         virtual GHOST_TSuccess init();
209
210     /**
211      * Handles a tablet event.
212      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
213      * @return Indication whether the event was handled. 
214      */
215     GHOST_TSuccess handleTabletEvent(void *eventPtr);
216     
217         /**
218      * Handles a mouse event.
219      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
220      * @return Indication whether the event was handled. 
221      */
222     GHOST_TSuccess handleMouseEvent(void *eventPtr);
223
224     /**
225      * Handles a key event.
226      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
227      * @return Indication whether the event was handled. 
228      */
229     GHOST_TSuccess handleKeyEvent(void *eventPtr);
230
231     /**
232      * Handles all basic Mac application stuff for a mouse down event.
233      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
234      * @return Indication whether the event was handled. 
235      */
236    // bool handleMouseDown(void *eventPtr);
237
238     /**
239      * Handles a Mac menu command.
240      * @param menuResult A Mac menu/item identifier.
241      * @return Indication whether the event was handled. 
242      */
243    // bool handleMenuCommand(GHOST_TInt32 menuResult);
244     
245     /* callback for blender generated events */
246 //      static OSStatus blendEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
247
248
249     /**
250      * Callback for Mac Timer tasks that expire.
251      * @param tmTask Pointer to the timer task that expired.
252      */
253     //static void s_timerCallback(TMTaskPtr tmTask);
254         
255     /** Event handler reference. */
256     //EventHandlerRef m_handler;
257         
258         /** Start time at initialization. */
259         GHOST_TUns64 m_start_time;
260         
261         /** Mouse buttons state */
262         GHOST_TUns32 m_pressedMouseButtons;
263         
264     /** State of the modifiers. */
265     GHOST_TUns32 m_modifierMask;
266
267     /** Ignores window size messages (when window is dragged). */
268     bool m_ignoreWindowSizedMessages;    
269 };
270
271 #endif // _GHOST_SYSTEM_COCOA_H_
272