Formatting edits <120 length lines
[blender.git] / intern / ghost / intern / GHOST_Window.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_Window.h
29  *  \ingroup GHOST
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 width                         The width the window.
79          * @param heigh                         The height the window.
80          * @param state                         The state the window is initially opened with.
81          * @param type                          The type of drawing context installed in this window.
82          * @param stereoVisual          Stereo visual for quad buffered stereo.
83          * @param numOfAASamples        Number of samples used for AA (zero if no AA)
84          */
85         GHOST_Window(
86                 GHOST_TUns32 width,
87                 GHOST_TUns32 height,
88                 GHOST_TWindowState state,
89                 GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
90                 const bool stereoVisual = false,
91                 const GHOST_TUns16 numOfAASamples = 0);
92
93         /**
94          * @section Interface inherited from GHOST_IWindow left for derived class
95          * implementation.
96          * virtual      bool getValid() const = 0;
97          * virtual void setTitle(const STR_String& title) = 0;
98          * virtual void getTitle(STR_String& title) const = 0;
99          * virtual      void getWindowBounds(GHOST_Rect& bounds) const = 0;
100          * virtual      void getClientBounds(GHOST_Rect& bounds) const = 0;
101          * virtual      GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
102          * virtual      GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
103          * virtual      GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
104          * virtual      void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
105          * virtual      void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
106          * virtual GHOST_TWindowState getState() const = 0;
107          * virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
108          * virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
109          * virtual GHOST_TSuccess swapBuffers() = 0;
110          * virtual GHOST_TSuccess activateDrawingContext() = 0;
111          * virtual GHOST_TSuccess invalidate() = 0;
112          */
113          
114         /**
115          * Destructor.
116          * Closes the window and disposes resources allocated.
117          */
118         virtual ~GHOST_Window();
119
120         /**
121          * Returns the associated OS object/handle
122          * @return The associated OS object/handle
123          */
124         virtual void* getOSWindow() const;
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      * Sets the progress bar value displayed in the window/application icon
190          * @param progress The progress % (0.0 to 1.0)
191          */
192         virtual GHOST_TSuccess setProgressBar(float progress) {return GHOST_kFailure;};
193         
194         /**
195          * Hides the progress bar in the icon
196          */
197         virtual GHOST_TSuccess endProgressBar() {return GHOST_kFailure;};
198         
199         /**
200          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
201          */
202         virtual void setAcceptDragOperation(bool canAccept);
203         
204         /**
205          * Returns acceptance of the dropped object
206          * Usually called by the "object dropped" event handling function
207          */
208         virtual bool canAcceptDragOperation() const;
209         
210         /**
211          * Sets the window "modified" status, indicating unsaved changes
212          * @param isUnsavedChanges Unsaved changes or not
213          * @return Indication of success.
214          */
215         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
216         
217         /**
218          * Gets the window "modified" status, indicating unsaved changes
219          * @return True if there are unsaved changes
220          */
221         virtual bool getModifiedState();
222         
223         /**
224          * Returns the type of drawing context used in this window.
225          * @return The current type of drawing context.
226          */
227         inline virtual GHOST_TDrawingContextType getDrawingContextType();
228
229         /**
230          * Tries to install a rendering context in this window.
231          * Child classes do not need to overload this method.
232          * They should overload the installDrawingContext and removeDrawingContext instead.
233          * @param type  The type of rendering context installed.
234          * @return Indication as to whether installation has succeeded.
235          */
236         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
237
238         /**
239          * Returns the window user data.
240          * @return The window user data.
241          */
242         inline virtual GHOST_TUserDataPtr getUserData() const
243         {
244                 return m_userData;
245         }
246         
247         /**
248          * Changes the window user data.
249          * @param data The window user data.
250          */
251         virtual void setUserData(const GHOST_TUserDataPtr userData)
252         {
253                 m_userData = userData;
254         }
255
256 protected:
257         /**
258          * Tries to install a rendering context in this window.
259          * @param type  The type of rendering context installed.
260          * @return Indication as to whether installation has succeeded.
261          */
262         virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
263
264         /**
265          * Removes the current drawing context.
266          * @return Indication as to whether removal has succeeded.
267          */
268         virtual GHOST_TSuccess removeDrawingContext() = 0;
269
270         /**
271          * Sets the cursor visibility on the window using
272          * native window system calls.
273          */
274         virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;
275
276         /**
277          * Sets the cursor grab on the window using
278          * native window system calls.
279          */
280         virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) { return GHOST_kSuccess; };
281         
282         /**
283          * Sets the cursor shape on the window using
284          * native window system calls.
285          */
286         virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;
287
288         /**
289          * Sets the cursor shape on the window using
290          * native window system calls.
291          */
292         virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2],
293                                                           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