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