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