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