part 1 of merge from trunk at r30358; it compiles, but doesn't link quite yet :)
[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_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 associated OS object/handle
128          * @return The associated OS object/handle
129          */
130         virtual void* getOSWindow() const;
131         
132         /**
133          * Returns the current cursor shape.
134          * @return      The current cursor shape.
135          */
136         inline virtual GHOST_TStandardCursor getCursorShape() const;
137
138         /**
139          * Set the shape of the cursor.
140          * @param       cursor  The new cursor shape type id.
141          * @return      Indication of success.
142          */
143         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
144
145         /**
146          * Set the shape of the cursor to a custom cursor.
147          * @param       bitmap  The bitmap data for the cursor.
148          * @param       mask    The mask data for the cursor.
149          * @param       hotX    The X coordinate of the cursor hotspot.
150          * @param       hotY    The Y coordinate of the cursor hotspot.
151          * @return      Indication of success.
152          */
153         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
154                                                                                                 GHOST_TUns8 mask[16][2], 
155                                                                                                 int hotX, 
156                                                                                                 int hotY);
157                                                                                                 
158         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
159                                                                                                 GHOST_TUns8 *mask, 
160                                                                                                 int sizex, int sizey,
161                                                                                                 int hotX,  int hotY,
162                                                                                                 int fg_color, int bg_color);
163         
164         /**
165          * Returns the visibility state of the cursor.
166          * @return      The visibility state of the cursor.
167          */
168         inline virtual bool getCursorVisibility() const;
169         inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
170         inline virtual void getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
171         inline virtual void getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
172         inline virtual void setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y);
173
174         /**
175          * Shows or hides the cursor.
176          * @param       visible The new visibility state of the cursor.
177          * @return      Indication of success.
178          */
179         virtual GHOST_TSuccess setCursorVisibility(bool visible);
180
181         /**
182          * Sets the cursor grab.
183          * @param       mode The new grab state of the cursor.
184          * @return      Indication of success.
185          */
186         virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds);
187
188         /**
189          * Gets the cursor grab region, if unset the window is used.
190          * reset when grab is disabled.
191          */
192         virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect& bounds);
193
194         /**
195      * Sets the progress bar value displayed in the window/application icon
196          * @param progress The progress % (0.0 to 1.0)
197          */
198         virtual GHOST_TSuccess setProgressBar(float progress) {return GHOST_kFailure;};
199         
200         /**
201          * Hides the progress bar in the icon
202          */
203         virtual GHOST_TSuccess endProgressBar() {return GHOST_kFailure;};
204         
205         /**
206          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
207          */
208         virtual void setAcceptDragOperation(bool canAccept);
209         
210         /**
211          * Returns acceptance of the dropped object
212          * Usually called by the "object dropped" event handling function
213          */
214         virtual bool canAcceptDragOperation() const;
215         
216         /**
217          * Sets the window "modified" status, indicating unsaved changes
218          * @param isUnsavedChanges Unsaved changes or not
219          * @return Indication of success.
220          */
221         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
222         
223         /**
224          * Gets the window "modified" status, indicating unsaved changes
225          * @return True if there are unsaved changes
226          */
227         virtual bool getModifiedState();
228         
229         /**
230          * Returns the type of drawing context used in this window.
231          * @return The current type of drawing context.
232          */
233         inline virtual GHOST_TDrawingContextType getDrawingContextType();
234
235         /**
236          * Tries to install a rendering context in this window.
237          * Child classes do not need to overload this method.
238          * They should overload the installDrawingContext and removeDrawingContext instead.
239          * @param type  The type of rendering context installed.
240          * @return Indication as to whether installation has succeeded.
241          */
242         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
243
244         /**
245          * Returns the window user data.
246          * @return The window user data.
247          */
248         inline virtual GHOST_TUserDataPtr getUserData() const
249         {
250                 return m_userData;
251         }
252         
253         /**
254          * Changes the window user data.
255          * @param data The window user data.
256          */
257         virtual void setUserData(const GHOST_TUserDataPtr userData)
258         {
259                 m_userData = userData;
260         }
261
262 protected:
263         /**
264          * Tries to install a rendering context in this window.
265          * @param type  The type of rendering context installed.
266          * @return Indication as to whether installation has succeeded.
267          */
268         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
269
270         /**
271          * Removes the current drawing context.
272          * @return Indication as to whether removal has succeeded.
273          */
274         virtual GHOST_TSuccess removeDrawingContext() = 0;
275
276         /**
277          * Sets the cursor visibility on the window using
278          * native window system calls.
279          */
280         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;
281
282         /**
283          * Sets the cursor grab on the window using
284          * native window system calls.
285          */
286         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) { return GHOST_kSuccess; };
287         
288         /**
289          * Sets the cursor shape on the window using
290          * native window system calls.
291          */
292         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;
293
294         /**
295          * Sets the cursor shape on the window using
296          * native window system calls.
297          */
298         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2],
299                                                          int hotX, int hotY) = 0;
300         
301         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, 
302                                                 int szx, int szy, int hotX, int hotY, int fg, int bg) = 0;
303         /** The the of drawing context installed in this window. */
304         GHOST_TDrawingContextType m_drawingContextType;
305         
306         /** The window user data */
307         GHOST_TUserDataPtr m_userData;
308
309         /** The current visibility of the cursor */
310         bool m_cursorVisible;
311
312         /** The current grabbed state of the cursor */
313         GHOST_TGrabCursorMode m_cursorGrab;
314
315         /** Initial grab location. */
316         GHOST_TInt32 m_cursorGrabInitPos[2];
317
318         /** Accumulated offset from m_cursorGrabInitPos. */
319         GHOST_TInt32 m_cursorGrabAccumPos[2];
320
321         /** Wrap the cursor within this region. */
322         GHOST_Rect m_cursorGrabBounds;
323
324         /** The current shape of the cursor */
325         GHOST_TStandardCursor m_cursorShape;
326     
327         /** The presence of progress indicator with the application icon */
328         bool m_progressBarVisible;
329         
330         /** The acceptance of the "drop candidate" of the current drag'n'drop operation */
331         bool m_canAcceptDragOperation;
332         
333         /** Modified state : are there unsaved changes */
334         bool m_isUnsavedChanges;
335         
336         /** Stores wether this is a full screen window. */
337         bool m_fullScreen;
338
339         /** Stereo visual created. Only necessary for 'real' stereo support,
340          *  ie quad buffered stereo. This is not always possible, depends on
341          *  the graphics h/w
342          */
343         bool m_stereoVisual;
344         
345         /** Number of samples used in anti-aliasing, set to 0 if no AA **/
346         GHOST_TUns16 m_numOfAASamples;
347     
348     /** Full-screen width */
349     GHOST_TUns32 m_fullScreenWidth;
350     /** Full-screen height */
351     GHOST_TUns32 m_fullScreenHeight;
352 };
353
354
355 inline GHOST_TDrawingContextType GHOST_Window::getDrawingContextType()
356 {
357         return m_drawingContextType;
358 }
359
360 inline bool GHOST_Window::getCursorVisibility() const
361 {
362         return m_cursorVisible;
363 }
364
365 inline GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode() const
366 {
367         return m_cursorGrab;
368 }
369
370 inline void GHOST_Window::getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const
371 {
372         x = m_cursorGrabInitPos[0];
373         y = m_cursorGrabInitPos[1];
374 }
375
376 inline void GHOST_Window::getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const
377 {
378         x= m_cursorGrabAccumPos[0];
379         y= m_cursorGrabAccumPos[1];
380 }
381
382 inline void GHOST_Window::setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y)
383 {
384         m_cursorGrabAccumPos[0]= x;
385         m_cursorGrabAccumPos[1]= y;
386 }
387
388 inline GHOST_TStandardCursor GHOST_Window::getCursorShape() const
389 {
390         return m_cursorShape;
391 }
392
393 #endif // _GHOST_WINDOW_H
394