2eeee621495c2ca69f4b4a7381a8a88b709a2941
[blender.git] / intern / ghost / GHOST_IWindow.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_IWindow.h
30  * Declaration of GHOST_IWindow interface class.
31  */
32
33 #ifndef _GHOST_IWINDOW_H_
34 #define _GHOST_IWINDOW_H_
35
36 #include "STR_String.h"
37 #include "GHOST_Rect.h"
38 #include "GHOST_Types.h"
39
40
41 /**
42  * Interface for GHOST windows.
43  *
44  * You can create a window with the system's GHOST_ISystem::createWindow 
45  * method.
46  * @see GHOST_ISystem#createWindow
47  *
48  * There are two coordinate systems:
49  * <ul>
50  * <li>The screen coordinate system. The origin of the screen is located in the
51  * upper left corner of the screen.</li> 
52  * <li>The client rectangle coordinate system. The client rectangle of a window
53  * is the area that is drawable by the application (excluding title bars etc.).
54  * </li> 
55  * </ul>
56  * @author      Maarten Gribnau
57  * @date        May 31, 2001
58  */
59 class GHOST_IWindow
60 {
61 public:
62         /**
63          * Destructor.
64          */
65         virtual ~GHOST_IWindow()
66         {
67         }
68
69         /**
70          * Returns indication as to whether the window is valid.
71          * @return The validity of the window.
72          */
73         virtual bool getValid() const = 0;
74
75         /**
76          * Returns the associated OS object/handle
77          * @return The associated OS object/handle
78          */
79         virtual void* getOSWindow() const = 0;
80
81         /**
82          * Returns the type of drawing context used in this window.
83          * @return The current type of drawing context.
84          */
85         virtual GHOST_TDrawingContextType getDrawingContextType() = 0;
86
87         /**
88          * Tries to install a rendering context in this window.
89          * @param type  The type of rendering context installed.
90          * @return Indication as to whether installation has succeeded.
91          */
92         virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
93
94         /**
95          * Sets the title displayed in the title bar.
96          * @param title The title to display in the title bar.
97          */
98         virtual void setTitle(const STR_String& title) = 0;
99
100         /**
101          * Returns the title displayed in the title bar.
102          * @param title The title displayed in the title bar.
103          */
104         virtual void getTitle(STR_String& title) const = 0;
105
106         /**
107          * Returns the window rectangle dimensions.
108          * These are screen coordinates.
109          * @param bounds The bounding rectangle of the window.
110          */
111         virtual void getWindowBounds(GHOST_Rect& bounds) const = 0;
112         
113         /**
114          * Returns the client rectangle dimensions.
115          * The left and top members of the rectangle are always zero.
116          * @param bounds The bounding rectangle of the client area of the window.
117          */
118         virtual void getClientBounds(GHOST_Rect& bounds) const = 0;
119
120         /**
121          * Resizes client rectangle width.
122          * @param width The new width of the client area of the window.
123          */
124         virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
125
126         /**
127          * Resizes client rectangle height.
128          * @param height The new height of the client area of the window.
129          */
130         virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
131
132         /**
133          * Resizes client rectangle.
134          * @param width         The new width of the client area of the window.
135          * @param height        The new height of the client area of the window.
136          */
137         virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
138
139         /**
140          * Converts a point in screen coordinates to client rectangle coordinates
141          * @param inX   The x-coordinate on the screen.
142          * @param inY   The y-coordinate on the screen.
143          * @param outX  The x-coordinate in the client rectangle.
144          * @param outY  The y-coordinate in the client rectangle.
145          */
146         virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
147
148         /**
149          * Converts a point in screen coordinates to client rectangle coordinates
150          * @param inX   The x-coordinate in the client rectangle.
151          * @param inY   The y-coordinate in the client rectangle.
152          * @param outX  The x-coordinate on the screen.
153          * @param outY  The y-coordinate on the screen.
154          */
155         virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
156
157         /**
158          * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
159          */
160         virtual void setAcceptDragOperation(bool canAccept) = 0;
161         
162         /**
163          * Returns acceptance of the dropped object
164          * Usually called by the "object dropped" event handling function
165          */
166         virtual bool canAcceptDragOperation() const = 0;
167         
168         /**
169          * Returns the state of the window (normal, minimized, maximized).
170          * @return The state of the window.
171          */
172         virtual GHOST_TWindowState getState() const = 0;
173
174         /**
175          * Sets the state of the window (normal, minimized, maximized).
176          * @param state The state of the window.
177          * @return Indication of success.
178          */
179         virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
180
181         /**
182          * Sets the window "modified" status, indicating unsaved changes
183          * @param isUnsavedChanges Unsaved changes or not
184          * @return Indication of success.
185          */
186         virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges) = 0;
187         
188         /**
189          * Gets the window "modified" status, indicating unsaved changes
190          * @return True if there are unsaved changes
191          */
192         virtual bool getModifiedState() = 0;
193         
194         /**
195          * Sets the order of the window (bottom, top).
196          * @param order The order of the window.
197          * @return Indication of success.
198          */
199         virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
200
201         /**
202          * Swaps front and back buffers of a window.
203          * @return      A boolean success indicator.
204          */
205         virtual GHOST_TSuccess swapBuffers() = 0;
206
207         /**
208          * Activates the drawing context of this window.
209          * @return      A boolean success indicator.
210          */
211         virtual GHOST_TSuccess activateDrawingContext() = 0;
212
213         /**
214          * Invalidates the contents of this window.
215          * @return Indication of success.
216          */
217         virtual GHOST_TSuccess invalidate() = 0;
218         
219         /**
220          * Returns the window user data.
221          * @return The window user data.
222          */
223         virtual GHOST_TUserDataPtr getUserData() const = 0;
224         
225         /**
226          * Changes the window user data.
227          * @param data The window user data.
228          */
229         virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
230         
231         /**
232          * Returns the tablet data (pressure etc).
233          * @return The tablet data (pressure etc).
234          */
235         virtual const GHOST_TabletData* GetTabletData() = 0;
236         
237         /***************************************************************************************
238          ** Progress bar functionality
239          ***************************************************************************************/
240         
241         /**
242      * Sets the progress bar value displayed in the window/application icon
243          * @param progress The progress %
244          */
245         virtual GHOST_TSuccess setProgressBar(float progress) = 0;
246         
247         /**
248          * Hides the progress bar in the icon
249          */
250         virtual GHOST_TSuccess endProgressBar() = 0;
251         
252         /***************************************************************************************
253          ** Cursor management functionality
254          ***************************************************************************************/
255
256         /**
257          * Returns the current cursor shape.
258          * @return      The current cursor shape.
259          */
260         virtual GHOST_TStandardCursor getCursorShape() const = 0;
261
262         /**
263          * Set the shape of the cursor.
264          * @param       cursor  The new cursor shape type id.
265          * @return      Indication of success.
266          */
267         virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
268
269         /**
270          * Set the shape of the cursor to a custom cursor.
271          * @param       bitmap  The bitmap data for the cursor.
272          * @param       mask    The mask data for the cursor.
273          * @param       hotX    The X coordinate of the cursor hotspot.
274          * @param       hotY    The Y coordinate of the cursor hotspot.
275          * @return      Indication of success.
276          */
277         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
278                                                                                                 GHOST_TUns8 mask[16][2], 
279                                                                                                 int hotX, 
280                                                                                                 int hotY) = 0;
281                                                                                                 
282         virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
283                                                                                                 GHOST_TUns8 *mask, 
284                                                                                                 int sizex, int sizey, 
285                                                                                                 int hotX, int hotY, 
286                                                                                                 int fg_color, int bg_color) = 0;
287
288         /**
289          * Returns the visibility state of the cursor.
290          * @return      The visibility state of the cursor.
291          */
292         virtual bool getCursorVisibility() const = 0;
293
294         /**
295          * Shows or hides the cursor.
296          * @param       visible The new visibility state of the cursor.
297          * @return      Indication of success.
298          */
299         virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
300
301         /**
302          * Grabs the cursor for a modal operation.
303          * @param       grab The new grab state of the cursor.
304          * @return      Indication of success.
305          */
306         virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds) { return GHOST_kSuccess; };
307
308 #ifdef WITH_CXX_GUARDEDALLOC
309 public:
310         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_IWindow"); }
311         void operator delete( void *mem ) { MEM_freeN(mem); }
312 #endif
313 };
314
315 #endif // _GHOST_IWINDOW_H_
316