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