Merging r40653 through r40847 from trunk into soc-2011-tomato
[blender.git] / intern / ghost / intern / GHOST_Window.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., 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_Window.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_Window class.
32  */
33
34 #ifndef _GHOST_WINDOW_H_
35 #define _GHOST_WINDOW_H_
36
37 #include "GHOST_IWindow.h"
38
39 class STR_String;
40
41 /**
42  * Platform independent implementation of GHOST_IWindow.
43  * Dimensions are given in screen coordinates that are relative to the 
44  * upper-left corner of the screen.
45  * Implements part of the GHOST_IWindow interface and adds some methods to
46  * be implemented by childs of this class.
47  * @author      Maarten Gribnau
48  * @date        May 7, 2001
49  */
50 class GHOST_Window : public GHOST_IWindow
51 {
52 public:
53         /**
54          * @section Interface inherited from GHOST_IWindow left for derived class
55          * implementation.
56          * virtual      bool getValid() const = 0;
57          * virtual void setTitle(const STR_String& title) = 0;
58          * virtual void getTitle(STR_String& title) const = 0;
59          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
60          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
61          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
62          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
63          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
64          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
65          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
66          * virtual GHOST_TWindowState getState() const = 0;
67          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
68          * virtual GHOST_TWindowOrder getOrder(void) = 0;
69          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
70          * virtual GHOST_TSuccess swapBuffers() = 0;
71          * virtual GHOST_TSuccess activateDrawingContext() = 0;
72          * virtual GHOST_TSuccess invalidate() = 0;
73          */
74
75         /**
76          * Constructor.
77          * Creates a new window and opens it.
78          * To check if the window was created properly, use the getValid() method.
79          * @param width                         The width the window.
80          * @param heigh                         The height the window.
81          * @param state                         The state the window is initially opened with.
82          * @param type                          The type of drawing context installed in this window.
83          * @param stereoVisual          Stereo visual for quad buffered stereo.
84          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
85          */
86         GHOST_Window(
87                 GHOST_TUns32 width,
88                 GHOST_TUns32 height,
89                 GHOST_TWindowState state,
90                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
91                 const bool stereoVisual = false,
92                 const GHOST_TUns16 numOfAASamples = 0);
93
94         /**
95          * @section Interface inherited from GHOST_IWindow left for derived class
96          * implementation.
97          * virtual      bool getValid() const = 0;
98          * virtual void setTitle(const STR_String& title) = 0;
99          * virtual void getTitle(STR_String& title) const = 0;
100          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
101          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
102          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
103          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
104          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
105          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
106          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
107          * virtual GHOST_TWindowState getState() const = 0;
108          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
109          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
110          * virtual GHOST_TSuccess swapBuffers() = 0;
111          * virtual GHOST_TSuccess activateDrawingContext() = 0;
112          * virtual GHOST_TSuccess invalidate() = 0;
113          */
114          
115         /**
116          * Destructor.
117          * Closes the window and disposes resources allocated.
118          */
119         virtual ~GHOST_Window();
120
121         /**
122          * Returns the associated OS object/handle
123          * @return The associated OS object/handle
124          */
125         virtual void* getOSWindow() const;
126         
127         /**
128          * Returns the current cursor shape.
129          * @return      The current cursor shape.
130          */
131         inline virtual GHOST_TStandardCursor getCursorShape() const;
132
133         /**
134          * Set the shape of the cursor.
135          * @param       cursor  The new cursor shape type id.
136          * @return      Indication of success.
137          */
138         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
139
140         /**
141          * Set the shape of the cursor to a custom cursor.
142          * @param       bitmap  The bitmap data for the cursor.
143          * @param       mask    The mask data for the cursor.
144          * @param       hotX    The X coordinate of the cursor hotspot.
145          * @param       hotY    The Y coordinate of the cursor hotspot.
146          * @return      Indication of success.
147          */
148         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
149                                                                                                 GHOST_TUns8 mask[16][2], 
150                                                                                                 int hotX, 
151                                                                                                 int hotY);
152                                                                                                 
153         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
154                                                                                                 GHOST_TUns8 *mask, 
155                                                                                                 int sizex, int sizey,
156                                                                                                 int hotX,  int hotY,
157                                                                                                 int fg_color, int bg_color);
158         
159         /**
160          * Returns the visibility state of the cursor.
161          * @return      The visibility state of the cursor.
162          */
163         inline virtual bool getCursorVisibility() const;
164         inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
165         inline virtual void getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
166         inline virtual void getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
167         inline virtual void setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y);
168
169         /**
170          * Shows or hides the cursor.
171          * @param       visible The new visibility state of the cursor.
172          * @return      Indication of success.
173          */
174         virtual GHOST_TSuccess setCursorVisibility(bool visible);
175
176         /**
177          * Sets the cursor grab.
178          * @param       mode The new grab state of the cursor.
179          * @return      Indication of success.
180          */
181         virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds);
182
183         /**
184          * Gets the cursor grab region, if unset the window is used.
185          * reset when grab is disabled.
186          */
187         virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect& bounds);
188
189         /**
190      * Sets the progress bar value displayed in the window/application icon
191          * @param progress The progress % (0.0 to 1.0)
192          */
193         virtual GHOST_TSuccess setProgressBar(float progress) {return GHOST_kFailure;};
194         
195         /**
196          * Hides the progress bar in the icon
197          */
198         virtual GHOST_TSuccess endProgressBar() {return GHOST_kFailure;};
199         
200         /**
201          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
202          */
203         virtual void setAcceptDragOperation(bool canAccept);
204         
205         /**
206          * Returns acceptance of the dropped object
207          * Usually called by the "object dropped" event handling function
208          */
209         virtual bool canAcceptDragOperation() const;
210         
211         /**
212          * Sets the window "modified" status, indicating unsaved changes
213          * @param isUnsavedChanges Unsaved changes or not
214          * @return Indication of success.
215          */
216         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
217         
218         /**
219          * Gets the window "modified" status, indicating unsaved changes
220          * @return True if there are unsaved changes
221          */
222         virtual bool getModifiedState();
223         
224         /**
225          * Returns the type of drawing context used in this window.
226          * @return The current type of drawing context.
227          */
228         inline virtual GHOST_TDrawingContextType getDrawingContextType();
229
230         /**
231          * Tries to install a rendering context in this window.
232          * Child classes do not need to overload this method.
233          * They should overload the installDrawingContext and removeDrawingContext instead.
234          * @param type  The type of rendering context installed.
235          * @return Indication as to whether installation has succeeded.
236          */
237         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
238
239         /**
240          * Returns the window user data.
241          * @return The window user data.
242          */
243         inline virtual GHOST_TUserDataPtr getUserData() const
244         {
245                 return m_userData;
246         }
247         
248         /**
249          * Changes the window user data.
250          * @param data The window user data.
251          */
252         virtual void setUserData(const GHOST_TUserDataPtr userData)
253         {
254                 m_userData = userData;
255         }
256
257 protected:
258         /**
259          * Tries to install a rendering context in this window.
260          * @param type  The type of rendering context installed.
261          * @return Indication as to whether installation has succeeded.
262          */
263         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
264
265         /**
266          * Removes the current drawing context.
267          * @return Indication as to whether removal has succeeded.
268          */
269         virtual GHOST_TSuccess removeDrawingContext() = 0;
270
271         /**
272          * Sets the cursor visibility on the window using
273          * native window system calls.
274          */
275         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;
276
277         /**
278          * Sets the cursor grab on the window using
279          * native window system calls.
280          */
281         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) { return GHOST_kSuccess; };
282         
283         /**
284          * Sets the cursor shape on the window using
285          * native window system calls.
286          */
287         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;
288
289         /**
290          * Sets the cursor shape on the window using
291          * native window system calls.
292          */
293         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2],
294                                                          int hotX, int hotY) = 0;
295         
296         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, 
297                                                 int szx, int szy, int hotX, int hotY, int fg, int bg) = 0;
298         /** The the of drawing context installed in this window. */
299         GHOST_TDrawingContextType m_drawingContextType;
300         
301         /** The window user data */
302         GHOST_TUserDataPtr m_userData;
303
304         /** The current visibility of the cursor */
305         bool m_cursorVisible;
306
307         /** The current grabbed state of the cursor */
308         GHOST_TGrabCursorMode m_cursorGrab;
309
310         /** Initial grab location. */
311         GHOST_TInt32 m_cursorGrabInitPos[2];
312
313         /** Accumulated offset from m_cursorGrabInitPos. */
314         GHOST_TInt32 m_cursorGrabAccumPos[2];
315
316         /** Wrap the cursor within this region. */
317         GHOST_Rect m_cursorGrabBounds;
318
319         /** The current shape of the cursor */
320         GHOST_TStandardCursor m_cursorShape;
321     
322         /** The presence of progress indicator with the application icon */
323         bool m_progressBarVisible;
324         
325         /** The acceptance of the "drop candidate" of the current drag'n'drop operation */
326         bool m_canAcceptDragOperation;
327         
328         /** Modified state : are there unsaved changes */
329         bool m_isUnsavedChanges;
330         
331         /** Stores wether this is a full screen window. */
332         bool m_fullScreen;
333
334         /** Stereo visual created. Only necessary for 'real' stereo support,
335          *  ie quad buffered stereo. This is not always possible, depends on
336          *  the graphics h/w
337          */
338         bool m_stereoVisual;
339         
340         /** Number of samples used in anti-aliasing, set to 0 if no AA **/
341         GHOST_TUns16 m_numOfAASamples;
342
343         /** Full-screen width */
344         GHOST_TUns32 m_fullScreenWidth;
345         /** Full-screen height */
346         GHOST_TUns32 m_fullScreenHeight;
347 };
348
349
350 inline GHOST_TDrawingContextType GHOST_Window::getDrawingContextType()
351 {
352         return m_drawingContextType;
353 }
354
355 inline bool GHOST_Window::getCursorVisibility() const
356 {
357         return m_cursorVisible;
358 }
359
360 inline GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode() const
361 {
362         return m_cursorGrab;
363 }
364
365 inline void GHOST_Window::getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const
366 {
367         x = m_cursorGrabInitPos[0];
368         y = m_cursorGrabInitPos[1];
369 }
370
371 inline void GHOST_Window::getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const
372 {
373         x= m_cursorGrabAccumPos[0];
374         y= m_cursorGrabAccumPos[1];
375 }
376
377 inline void GHOST_Window::setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y)
378 {
379         m_cursorGrabAccumPos[0]= x;
380         m_cursorGrabAccumPos[1]= y;
381 }
382
383 inline GHOST_TStandardCursor GHOST_Window::getCursorShape() const
384 {
385         return m_cursorShape;
386 }
387
388 #endif // _GHOST_WINDOW_H
389