Audaspace Py API: Improving Docs (Crosslinks, etc).
[blender-staging.git] / intern / ghost / GHOST_C-api.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_C-api.h
30  * GHOST C-API function and type declarations.
31  * The C-API wraps the C++ objects with the 
32  */
33
34 #ifndef GHOST_C_API_H
35 #define GHOST_C_API_H
36
37 #include "GHOST_Types.h"
38
39 #ifdef __cplusplus
40 extern "C" { 
41 #endif
42
43 /**
44  * Creates a "handle" for a C++ GHOST object.
45  * A handle is just an opaque pointer to an empty struct.
46  * In the API the pointer is casted to the actual C++ class.
47  * @param       name    Name of the handle to create.
48  */
49 #define GHOST_DECLARE_HANDLE(name) typedef struct name##__ { int unused; } *name
50
51 GHOST_DECLARE_HANDLE(GHOST_SystemHandle);
52 GHOST_DECLARE_HANDLE(GHOST_TimerTaskHandle);
53 GHOST_DECLARE_HANDLE(GHOST_WindowHandle);
54 GHOST_DECLARE_HANDLE(GHOST_EventHandle);
55 GHOST_DECLARE_HANDLE(GHOST_RectangleHandle);
56 GHOST_DECLARE_HANDLE(GHOST_EventConsumerHandle);
57
58
59 /**
60  * Definition of a callback routine that receives events.
61  * @param event The event received.
62  * @param userdata The callback's user data, supplied to GHOST_CreateSystem.
63  */
64 typedef int (*GHOST_EventCallbackProcPtr)(GHOST_EventHandle event, GHOST_TUserDataPtr userdata);
65
66
67 /**
68  * Creates the one and only system.
69  * @return a handle to the system.
70  */
71 extern GHOST_SystemHandle GHOST_CreateSystem(void);
72
73 /**
74  * Disposes the one and only system.
75  * @param systemhandle The handle to the system
76  * @return An indication of success.
77  */
78 extern GHOST_TSuccess GHOST_DisposeSystem(GHOST_SystemHandle systemhandle);
79
80
81 /**
82  * Creates an event consumer object
83  * @param eventCallback The event callback routine.
84  * @param userdata              Pointer to user data returned to the callback routine.
85  */
86 extern GHOST_EventConsumerHandle GHOST_CreateEventConsumer(GHOST_EventCallbackProcPtr eventCallback, GHOST_TUserDataPtr userdata);
87
88 /**
89  * Disposes an event consumer object
90  * @param consumerhandle        Handle to the event consumer.
91  * @return An indication of success.
92  */
93 extern GHOST_TSuccess GHOST_DisposeEventConsumer(GHOST_EventConsumerHandle consumerhandle);
94
95
96 /**
97  * Returns the system time.
98  * Returns the number of milliseconds since the start of the system process.
99  * Based on ANSI clock() routine.
100  * @param systemhandle The handle to the system
101  * @return The number of milliseconds.
102  */
103 extern GHOST_TUns64 GHOST_GetMilliSeconds(GHOST_SystemHandle systemhandle);
104
105 /**
106  * Installs a timer.
107  * Note that, on most operating systems, messages need to be processed in order 
108  * for the timer callbacks to be invoked.
109  * @param systemhandle The handle to the system
110  * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
111  * @param interval      The interval between calls to the timerProc (in milliseconds)
112  * @param timerProc     The callback invoked when the interval expires,
113  * @param userData      Placeholder for user data.
114  * @return A timer task (0 if timer task installation failed).
115  */
116 extern GHOST_TimerTaskHandle GHOST_InstallTimer(GHOST_SystemHandle systemhandle,
117                                                                                                 GHOST_TUns64 delay,
118                                                                                                 GHOST_TUns64 interval,
119                                                                                                 GHOST_TimerProcPtr timerProc,
120                                                                                                 GHOST_TUserDataPtr userData);
121
122 /**
123  * Removes a timer.
124  * @param systemhandle The handle to the system
125  * @param timerTask Timer task to be removed.
126  * @return Indication of success.
127  */
128 extern GHOST_TSuccess GHOST_RemoveTimer(GHOST_SystemHandle systemhandle,
129                                                                                 GHOST_TimerTaskHandle timertaskhandle);
130
131 /***************************************************************************************
132  ** Display/window management functionality
133  ***************************************************************************************/
134
135 /**
136  * Returns the number of displays on this system.
137  * @param systemhandle The handle to the system
138  * @return The number of displays.
139  */
140 extern GHOST_TUns8 GHOST_GetNumDisplays(GHOST_SystemHandle systemhandle);
141
142 /**
143  * Returns the dimensions of the main display on this system.
144  * @param systemhandle The handle to the system
145  * @param width         A pointer the width gets put in
146  * @param height        A pointer the height gets put in
147  * @return void.
148  */
149 extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle,
150                                                                                    GHOST_TUns32* width,
151                                                                                    GHOST_TUns32* height);
152
153 /**
154  * Create a new window.
155  * The new window is added to the list of windows managed. 
156  * Never explicitly delete the window, use disposeWindow() instead.
157  * @param systemhandle The handle to the system
158  * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
159  * @param       left    The coordinate of the left edge of the window.
160  * @param       top             The coordinate of the top edge of the window.
161  * @param       width   The width the window.
162  * @param       height  The height the window.
163  * @param       state   The state of the window when opened.
164  * @param       type    The type of drawing context installed in this window.
165  * @param stereoVisual          Stereo visual for quad buffered stereo.
166  * @param numOfAASamples        Number of samples used for AA (zero if no AA)
167  * @return      A handle to the new window ( == NULL if creation failed).
168  */
169 extern GHOST_WindowHandle GHOST_CreateWindow(GHOST_SystemHandle systemhandle,
170         char* title,
171         GHOST_TInt32 left,
172         GHOST_TInt32 top,
173         GHOST_TUns32 width,
174         GHOST_TUns32 height,
175         GHOST_TWindowState state,
176         GHOST_TDrawingContextType type,
177         const int stereoVisual,
178         const GHOST_TUns16 numOfAASamples);
179
180 /**
181  * Returns the window user data.
182  * @param windowhandle  The handle to the window
183  * @return The window user data.
184  */
185 extern GHOST_TUserDataPtr GHOST_GetWindowUserData(GHOST_WindowHandle windowhandle);
186         
187 /**
188  * Changes the window user data.
189  * @param windowhandle  The handle to the window
190  * @param data The window user data.
191  */
192 extern void GHOST_SetWindowUserData(GHOST_WindowHandle windowhandle, 
193         GHOST_TUserDataPtr userdata);
194
195 /**
196  * Dispose a window.
197  * @param systemhandle The handle to the system
198  * @param       window Handle to the window to be disposed.
199  * @return      Indication of success.
200  */
201 extern GHOST_TSuccess GHOST_DisposeWindow(GHOST_SystemHandle systemhandle,
202                                                                                   GHOST_WindowHandle windowhandle);
203
204 /**
205  * Returns whether a window is valid.
206  * @param systemhandle The handle to the system
207  * @param       window Handle to the window to be checked.
208  * @return      Indication of validity.
209  */
210 extern int GHOST_ValidWindow(GHOST_SystemHandle systemhandle,
211                                                                                 GHOST_WindowHandle windowhandle);
212
213 /**
214  * Begins full screen mode.
215  * @param systemhandle The handle to the system
216  * @param setting       The new setting of the display.
217  * @return                      A handle to the window displayed in full screen.
218  *                                      This window is invalid after full screen has been ended.
219  */
220 extern GHOST_WindowHandle GHOST_BeginFullScreen(GHOST_SystemHandle systemhandle,
221         GHOST_DisplaySetting* setting,
222         const int stereoVisual);
223
224 /**
225  * Ends full screen mode.
226  * @param systemhandle The handle to the system
227  * @return      Indication of success.
228  */
229 extern GHOST_TSuccess GHOST_EndFullScreen(GHOST_SystemHandle systemhandle);
230
231 /**
232  * Returns current full screen mode status.
233  * @param systemhandle The handle to the system
234  * @return The current status.
235  */
236 extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle);
237
238 /***************************************************************************************
239  ** Event management functionality
240  ***************************************************************************************/
241
242 /**
243  * Retrieves events from the system and stores them in the queue.
244  * @param systemhandle The handle to the system
245  * @param waitForEvent Boolean to indicate that ProcessEvents should
246  * wait (block) until the next event before returning.
247  * @return Indication of the presence of events.
248  */
249 extern int GHOST_ProcessEvents(GHOST_SystemHandle systemhandle, int waitForEvent);
250
251 /**
252  * Retrieves events from the queue and send them to the event consumers.
253  * @param systemhandle The handle to the system
254  * @return Indication of the presence of events.
255  */
256 extern int GHOST_DispatchEvents(GHOST_SystemHandle systemhandle);
257
258 /**
259  * Adds the given event consumer to our list.
260  * @param systemhandle The handle to the system
261  * @param consumerhandle The event consumer to add.
262  * @return Indication of success.
263  */
264 extern GHOST_TSuccess GHOST_AddEventConsumer(GHOST_SystemHandle systemhandle,
265                                                                                           GHOST_EventConsumerHandle consumerhandle);
266         
267 /***************************************************************************************
268  ** Progress bar functionality
269  ***************************************************************************************/
270
271 /**
272  * Sets the progress bar value displayed in the window/application icon
273  * @param windowhandle The handle to the window
274  * @param progress The progress % (0.0 to 1.0)
275  */
276 extern GHOST_TSuccess GHOST_SetProgressBar(GHOST_WindowHandle windowhandle, float progress);
277
278 /**
279  * Hides the progress bar in the icon
280  * @param windowhandle The handle to the window
281  */
282 extern GHOST_TSuccess GHOST_EndProgressBar(GHOST_WindowHandle windowhandle);
283         
284         
285 /***************************************************************************************
286  ** N-degree of freedom device management functionality
287  ***************************************************************************************/
288  
289 /**
290 * Open N-degree of freedom devices
291  */
292 extern int GHOST_OpenNDOF(GHOST_SystemHandle systemhandle, 
293                            GHOST_WindowHandle windowhandle,
294                           GHOST_NDOFLibraryInit_fp setNdofLibraryInit, 
295                           GHOST_NDOFLibraryShutdown_fp setNdofLibraryShutdown,
296                           GHOST_NDOFDeviceOpen_fp setNdofDeviceOpen
297                           );
298
299 /***************************************************************************************
300  ** Cursor management functionality
301  ***************************************************************************************/
302
303 /**
304  * Returns the current cursor shape.
305  * @param windowhandle The handle to the window
306  * @return      The current cursor shape.
307  */
308 extern GHOST_TStandardCursor GHOST_GetCursorShape(GHOST_WindowHandle windowhandle);
309
310 /**
311  * Set the shape of the cursor.
312  * @param windowhandle The handle to the window
313  * @param       cursor  The new cursor shape type id.
314  * @return      Indication of success.
315  */
316 extern GHOST_TSuccess GHOST_SetCursorShape(GHOST_WindowHandle windowhandle,
317                                                                                    GHOST_TStandardCursor cursorshape);
318
319 /**
320  * Set the shape of the cursor to a custom cursor.
321  * @param windowhandle The handle to the window
322  * @param       bitmap  The bitmap data for the cursor.
323  * @param       mask    The mask data for the cursor.
324  * @param       hotX    The X coordinate of the cursor hotspot.
325  * @param       hotY    The Y coordinate of the cursor hotspot.
326  * @return      Indication of success.
327  */
328 extern GHOST_TSuccess GHOST_SetCustomCursorShape(GHOST_WindowHandle windowhandle,
329                                                                                                  GHOST_TUns8 bitmap[16][2], 
330                                                                                                  GHOST_TUns8 mask[16][2], 
331                                                                                                  int hotX, 
332                                                                                                  int hotY);
333 /**
334  * Set the shape of the cursor to a custom cursor of specified size.
335  * @param windowhandle The handle to the window
336  * @param       bitmap  The bitmap data for the cursor.
337  * @param       mask    The mask data for the cursor.
338  * @parm    sizex, sizey  The size of the cursor
339  * @param       hotX    The X coordinate of the cursor hotspot.
340  * @param       hotY    The Y coordinate of the cursor hotspot.
341  * @param   fg_color, bg_color  Colors of the cursor
342  * @return      Indication of success.
343   */
344 extern GHOST_TSuccess GHOST_SetCustomCursorShapeEx(GHOST_WindowHandle windowhandle,
345                                                                                                  GHOST_TUns8 *bitmap, 
346                                                                                                  GHOST_TUns8 *mask, 
347                                                                                                  int sizex, int sizey, 
348                                                                                                  int hotX,  int hotY,
349                                                                                                  int fg_color, int bg_color );
350
351 /**
352  * Returns the visibility state of the cursor.
353  * @param windowhandle The handle to the window
354  * @return      The visibility state of the cursor.
355  */
356 extern int GHOST_GetCursorVisibility(GHOST_WindowHandle windowhandle);
357
358 /**
359  * Shows or hides the cursor.
360  * @param windowhandle The handle to the window
361  * @param       visible The new visibility state of the cursor.
362  * @return      Indication of success.
363  */
364 extern GHOST_TSuccess GHOST_SetCursorVisibility(GHOST_WindowHandle windowhandle,
365                                                                                                 int visible);
366
367 /**
368  * Returns the current location of the cursor (location in screen coordinates)
369  * @param systemhandle The handle to the system
370  * @param x                     The x-coordinate of the cursor.
371  * @param y                     The y-coordinate of the cursor.
372  * @return                      Indication of success.
373  */
374 extern GHOST_TSuccess GHOST_GetCursorPosition(GHOST_SystemHandle systemhandle,
375                                                                                           GHOST_TInt32* x,
376                                                                                           GHOST_TInt32* y);
377
378 /**
379  * Updates the location of the cursor (location in screen coordinates).
380  * Not all operating systems allow the cursor to be moved (without the input device being moved).
381  * @param systemhandle The handle to the system
382  * @param x                     The x-coordinate of the cursor.
383  * @param y                     The y-coordinate of the cursor.
384  * @return                      Indication of success.
385  */
386 extern GHOST_TSuccess GHOST_SetCursorPosition(GHOST_SystemHandle systemhandle,
387                                                                                           GHOST_TInt32 x,
388                                                                                           GHOST_TInt32 y);
389
390 /**
391  * Grabs the cursor for a modal operation, to keep receiving
392  * events when the mouse is outside the window. X11 only, others
393  * do this automatically.
394  * @param windowhandle The handle to the window
395  * @param       mode The new grab state of the cursor.
396  * @param       bounds The grab ragion (optional) - left,top,right,bottom
397  * @return      Indication of success.
398  */
399 extern GHOST_TSuccess GHOST_SetCursorGrab(GHOST_WindowHandle windowhandle,
400                                                                                                 GHOST_TGrabCursorMode mode,
401                                                                                                 int* bounds);
402
403 /***************************************************************************************
404  ** Access to mouse button and keyboard states.
405  ***************************************************************************************/
406
407 /**
408  * Returns the state of a modifier key (ouside the message queue).
409  * @param systemhandle The handle to the system
410  * @param mask          The modifier key state to retrieve.
411  * @param isDown        Pointer to return modifier state in.
412  * @return                      Indication of success.
413  */
414 extern GHOST_TSuccess GHOST_GetModifierKeyState(GHOST_SystemHandle systemhandle,
415                                                                                                 GHOST_TModifierKeyMask mask,
416                                                                                                 int* isDown);
417
418 /**
419  * Returns the state of a mouse button (ouside the message queue).
420  * @param systemhandle The handle to the system
421  * @param mask          The button state to retrieve.
422  * @param isDown        Pointer to return button state in.
423  * @return                      Indication of success.
424  */
425 extern GHOST_TSuccess GHOST_GetButtonState(GHOST_SystemHandle systemhandle,
426                                                                                    GHOST_TButtonMask mask,
427                                                                                    int* isDown);
428
429
430 /***************************************************************************************
431  ** Drag'n'drop operations
432  ***************************************************************************************/
433
434 /**
435  * Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
436  */
437 extern void GHOST_setAcceptDragOperation(GHOST_WindowHandle windowhandle, GHOST_TInt8 canAccept);
438         
439         
440 /**
441  * Returns the event type.
442  * @param eventhandle The handle to the event
443  * @return The event type.
444  */
445 extern GHOST_TEventType GHOST_GetEventType(GHOST_EventHandle eventhandle);
446
447 /**
448  * Returns the time this event was generated.
449  * @param eventhandle The handle to the event
450  * @return The event generation time.
451  */
452 extern GHOST_TUns64 GHOST_GetEventTime(GHOST_EventHandle eventhandle);
453
454 /**
455  * Returns the window this event was generated on, 
456  * or NULL if it is a 'system' event.
457  * @param eventhandle The handle to the event
458  * @return The generating window.
459  */
460 extern GHOST_WindowHandle GHOST_GetEventWindow(GHOST_EventHandle eventhandle);
461
462 /**
463  * Returns the event data.
464  * @param eventhandle The handle to the event
465  * @return The event data.
466  */
467 extern GHOST_TEventDataPtr GHOST_GetEventData(GHOST_EventHandle eventhandle);
468
469 /**
470  * Returns the timer callback.
471  * @param timertaskhandle       The handle to the timertask
472  * @return The timer callback.
473  */
474 extern GHOST_TimerProcPtr GHOST_GetTimerProc(GHOST_TimerTaskHandle timertaskhandle);
475
476 /**
477  * Changes the timer callback.
478  * @param timertaskhandle The handle to the timertask
479  * @param timerProc The timer callback.
480  */
481 extern void GHOST_SetTimerProc(GHOST_TimerTaskHandle timertaskhandle,
482                                                            GHOST_TimerProcPtr timerProc);
483
484 /**
485  * Returns the timer user data.
486  * @param timertaskhandle       The handle to the timertask
487  * @return The timer user data.
488  */
489 extern GHOST_TUserDataPtr GHOST_GetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle);
490         
491 /**
492  * Changes the time user data.
493  * @param timertaskhandle       The handle to the timertask
494  * @param data The timer user data.
495  */
496 extern void GHOST_SetTimerTaskUserData(GHOST_TimerTaskHandle timertaskhandle,
497                                                                            GHOST_TUserDataPtr userData);
498
499 /**
500  * Returns indication as to whether the window is valid.
501  * @param windowhandle The handle to the window
502  * @return The validity of the window.
503  */
504 extern int GHOST_GetValid(GHOST_WindowHandle windowhandle) ;
505
506 /**
507  * Returns the type of drawing context used in this window.
508  * @param windowhandle The handle to the window
509  * @return The current type of drawing context.
510  */
511 extern GHOST_TDrawingContextType GHOST_GetDrawingContextType(GHOST_WindowHandle windowhandle);
512
513 /**
514  * Tries to install a rendering context in this window.
515  * @param windowhandle The handle to the window
516  * @param type  The type of rendering context installed.
517  * @return Indication as to whether installation has succeeded.
518  */
519 extern GHOST_TSuccess GHOST_SetDrawingContextType(GHOST_WindowHandle windowhandle,
520                                                                                                   GHOST_TDrawingContextType type);
521
522 /**
523  * Sets the title displayed in the title bar.
524  * @param windowhandle The handle to the window
525  * @param title The title to display in the title bar.
526  */
527 extern void GHOST_SetTitle(GHOST_WindowHandle windowhandle,
528                                                    char* title);
529
530 /**
531  * Returns the title displayed in the title bar. The title
532  * should be free'd with free().
533  * 
534  * @param windowhandle The handle to the window
535  * @return The title, free with free().
536  */
537 extern char* GHOST_GetTitle(GHOST_WindowHandle windowhandle);
538
539 /**
540  * Returns the window rectangle dimensions.
541  * These are screen coordinates.
542  * @param windowhandle The handle to the window
543  * @return A handle to the bounding rectangle of the window.
544  */
545 extern GHOST_RectangleHandle GHOST_GetWindowBounds(GHOST_WindowHandle windowhandle);
546
547 /**
548  * Returns the client rectangle dimensions.
549  * The left and top members of the rectangle are always zero.
550  * @param windowhandle The handle to the window
551  * @return A handle to the bounding rectangle of the window.
552  */
553 extern GHOST_RectangleHandle GHOST_GetClientBounds(GHOST_WindowHandle windowhandle);
554
555 /**
556  * Disposes a rectangle object
557  * @param rectanglehandle       Handle to the rectangle.
558  */
559 void GHOST_DisposeRectangle(GHOST_RectangleHandle rectanglehandle);
560
561 /**
562  * Resizes client rectangle width.
563  * @param windowhandle The handle to the window
564  * @param width The new width of the client area of the window.
565  * @return      Indication of success.
566  */
567 extern GHOST_TSuccess GHOST_SetClientWidth(GHOST_WindowHandle windowhandle,
568                                                                                    GHOST_TUns32 width);
569
570 /**
571  * Resizes client rectangle height.
572  * @param windowhandle The handle to the window
573  * @param height The new height of the client area of the window.
574  * @return      Indication of success.
575  */
576 extern GHOST_TSuccess GHOST_SetClientHeight(GHOST_WindowHandle windowhandle,
577                                                                                         GHOST_TUns32 height);
578
579 /**
580  * Resizes client rectangle.
581  * @param windowhandle The handle to the window
582  * @param width         The new width of the client area of the window.
583  * @param height        The new height of the client area of the window.
584  * @return                      Indication of success.
585  */
586 extern GHOST_TSuccess GHOST_SetClientSize(GHOST_WindowHandle windowhandle,
587                                                                                   GHOST_TUns32 width,
588                                                                                   GHOST_TUns32 height);
589
590 /**
591  * Converts a point in screen coordinates to client rectangle coordinates
592  * @param windowhandle The handle to the window
593  * @param inX   The x-coordinate on the screen.
594  * @param inY   The y-coordinate on the screen.
595  * @param outX  The x-coordinate in the client rectangle.
596  * @param outY  The y-coordinate in the client rectangle.
597  */
598 extern void GHOST_ScreenToClient(GHOST_WindowHandle windowhandle,
599                                                                  GHOST_TInt32 inX,
600                                                                  GHOST_TInt32 inY,
601                                                                  GHOST_TInt32* outX,
602                                                                  GHOST_TInt32* outY) ;
603
604 /**
605  * Converts a point in screen coordinates to client rectangle coordinates
606  * @param windowhandle The handle to the window
607  * @param inX   The x-coordinate in the client rectangle.
608  * @param inY   The y-coordinate in the client rectangle.
609  * @param outX  The x-coordinate on the screen.
610  * @param outY  The y-coordinate on the screen.
611  */
612 extern void GHOST_ClientToScreen(GHOST_WindowHandle windowhandle,
613                                                                  GHOST_TInt32 inX,
614                                                                  GHOST_TInt32 inY,
615                                                                  GHOST_TInt32* outX,
616                                                                  GHOST_TInt32* outY);
617
618 /**
619  * Returns the state of the window (normal, minimized, maximized).
620  * @param windowhandle The handle to the window
621  * @return The state of the window.
622  */
623 extern GHOST_TWindowState GHOST_GetWindowState(GHOST_WindowHandle windowhandle);
624
625 /**
626  * Sets the state of the window (normal, minimized, maximized).
627  * @param windowhandle The handle to the window
628  * @param state The state of the window.
629  * @return Indication of success.
630  */
631 extern GHOST_TSuccess GHOST_SetWindowState(GHOST_WindowHandle windowhandle,
632                                                                                    GHOST_TWindowState state);
633
634         
635 /**
636  * Sets the window "modified" status, indicating unsaved changes
637  * @param windowhandle The handle to the window
638  * @param isUnsavedChanges Unsaved changes or not
639  * @return Indication of success.
640  */
641 extern GHOST_TSuccess GHOST_SetWindowModifiedState(GHOST_WindowHandle windowhandle,
642                                                                                                    GHOST_TUns8 isUnsavedChanges);
643         
644 /**
645  * Sets the order of the window (bottom, top).
646  * @param windowhandle The handle to the window
647  * @param order The order of the window.
648  * @return Indication of success.
649  */
650 extern GHOST_TSuccess GHOST_SetWindowOrder(GHOST_WindowHandle windowhandle,
651                                                                                    GHOST_TWindowOrder order);
652
653 /**
654  * Swaps front and back buffers of a window.
655  * @param windowhandle The handle to the window
656  * @return      An intean success indicator.
657  */
658 extern GHOST_TSuccess GHOST_SwapWindowBuffers(GHOST_WindowHandle windowhandle);
659
660 /**
661  * Activates the drawing context of this window.
662  * @param windowhandle The handle to the window
663  * @return      An intean success indicator.
664  */
665 extern GHOST_TSuccess GHOST_ActivateWindowDrawingContext(GHOST_WindowHandle windowhandle);
666
667 /**
668  * Invalidates the contents of this window.
669  * @param windowhandle The handle to the window
670  * @return Indication of success.
671  */
672 extern GHOST_TSuccess GHOST_InvalidateWindow(GHOST_WindowHandle windowhandle);
673
674 /**
675  * Returns the status of the tablet
676  * @param windowhandle The handle to the window
677  * @return Status of tablet
678  */
679 extern const GHOST_TabletData *GHOST_GetTabletData(GHOST_WindowHandle windowhandle);
680
681 /**
682  * Access to rectangle width.
683  * @param rectanglehandle The handle to the rectangle
684  * @return      width of the rectangle
685  */
686 extern GHOST_TInt32 GHOST_GetWidthRectangle(GHOST_RectangleHandle rectanglehandle);
687
688 /**
689  * Access to rectangle height.
690  * @param rectanglehandle The handle to the rectangle
691  * @return      height of the rectangle
692  */
693 extern GHOST_TInt32 GHOST_GetHeightRectangle(GHOST_RectangleHandle rectanglehandle);
694
695 /**
696  * Gets all members of the rectangle.
697  * @param rectanglehandle The handle to the rectangle
698  * @param       l       Pointer to return left coordinate in.
699  * @param       t       Pointer to return top coordinate in.
700  * @param       r       Pointer to return right coordinate in.
701  * @param       b       Pointer to return bottom coordinate in.
702  */
703 extern void GHOST_GetRectangle(GHOST_RectangleHandle rectanglehandle,
704                                                            GHOST_TInt32* l,
705                                                            GHOST_TInt32* t,
706                                                            GHOST_TInt32* r,
707                                                            GHOST_TInt32* b);
708
709 /**
710  * Sets all members of the rectangle.
711  * @param rectanglehandle The handle to the rectangle
712  * @param       l       requested left coordinate of the rectangle
713  * @param       t       requested top coordinate of the rectangle
714  * @param       r       requested right coordinate of the rectangle
715  * @param       b       requested bottom coordinate of the rectangle
716  */
717 extern void GHOST_SetRectangle(GHOST_RectangleHandle rectanglehandle,
718                                                            GHOST_TInt32 l,
719                                                            GHOST_TInt32 t,
720                                                            GHOST_TInt32 r,
721                                                            GHOST_TInt32 b);
722
723 /**
724  * Returns whether this rectangle is empty.
725  * Empty rectangles are rectangles that have width==0 and/or height==0.
726  * @param rectanglehandle The handle to the rectangle
727  * @return      intean value (true == empty rectangle)
728  */
729 extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehandle);
730
731 /**
732  * Returns whether this rectangle is valid.
733  * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
734  * @param rectanglehandle The handle to the rectangle
735  * @return      intean value (true==valid rectangle)
736  */
737 extern GHOST_TSuccess GHOST_IsValidRectangle(GHOST_RectangleHandle rectanglehandle);
738
739 /**
740  * Grows (or shrinks the rectangle).
741  * The method avoids negative insets making the rectangle invalid
742  * @param rectanglehandle The handle to the rectangle
743  * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
744  */
745 extern void GHOST_InsetRectangle(GHOST_RectangleHandle rectanglehandle,
746                                                                  GHOST_TInt32 i);
747
748 /**
749  * Does a union of the rectangle given and this rectangle.
750  * The result is stored in this rectangle.
751  * @param rectanglehandle The handle to the rectangle
752  * @param       r       The rectangle that is input for the union operation.
753  */
754 extern void GHOST_UnionRectangle(GHOST_RectangleHandle rectanglehandle,
755                                                                  GHOST_RectangleHandle anotherrectanglehandle);
756
757 /**
758  * Grows the rectangle to included a point.
759  * @param rectanglehandle The handle to the rectangle
760  * @param       x       The x-coordinate of the point.
761  * @param       y       The y-coordinate of the point.
762  */
763 extern void GHOST_UnionPointRectangle(GHOST_RectangleHandle rectanglehandle,
764                                                                           GHOST_TInt32 x,
765                                                                           GHOST_TInt32 y);
766
767 /**
768  * Returns whether the point is inside this rectangle.
769  * Point on the boundary is considered inside.
770  * @param rectanglehandle The handle to the rectangle
771  * @param x     x-coordinate of point to test.
772  * @param y y-coordinate of point to test.
773  * @return intean value (true if point is inside).
774  */
775 extern GHOST_TSuccess GHOST_IsInsideRectangle(GHOST_RectangleHandle rectanglehandle,
776                                                                                           GHOST_TInt32 x,
777                                                                                           GHOST_TInt32 y);
778
779 /**
780  * Returns whether the rectangle is inside this rectangle.
781  * @param rectanglehandle The handle to the rectangle
782  * @param       r       rectangle to test.
783  * @return      visibility (not, partially or fully visible).
784  */
785 extern GHOST_TVisibility GHOST_GetRectangleVisibility(GHOST_RectangleHandle rectanglehandle,
786                                                                                                           GHOST_RectangleHandle anotherrectanglehandle);
787
788 /**
789  * Sets rectangle members.
790  * Sets rectangle members such that it is centered at the given location.
791  * @param rectanglehandle The handle to the rectangle
792  * @param       cx      requested center x-coordinate of the rectangle
793  * @param       cy      requested center y-coordinate of the rectangle
794  */
795 extern void GHOST_SetCenterRectangle(GHOST_RectangleHandle rectanglehandle,
796                                                                          GHOST_TInt32 cx,
797                                                                          GHOST_TInt32 cy);
798
799 /**
800  * Sets rectangle members.
801  * Sets rectangle members such that it is centered at the given location,
802  * with the width requested.
803  * @param rectanglehandle The handle to the rectangle
804  * @param       cx      requested center x-coordinate of the rectangle
805  * @param       cy      requested center y-coordinate of the rectangle
806  * @param       w       requested width of the rectangle
807  * @param       h       requested height of the rectangle
808  */
809 extern void GHOST_SetRectangleCenter(GHOST_RectangleHandle rectanglehandle,
810                                                                          GHOST_TInt32 cx,
811                                                                          GHOST_TInt32 cy,
812                                                                          GHOST_TInt32 w,
813                                                                          GHOST_TInt32 h);
814
815 /**
816  * Clips a rectangle.
817  * Updates the rectangle given such that it will fit within this one.
818  * This can result in an empty rectangle.
819  * @param rectanglehandle The handle to the rectangle
820  * @param       r       the rectangle to clip
821  * @return      whether clipping has occurred
822  */
823 extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle,
824                                                                                   GHOST_RectangleHandle anotherrectanglehandle);
825
826 /**
827  * Return the data from the clipboad
828  * @param       return the selection instead, X11 only feature
829  * @return      clipboard data
830  */
831 extern GHOST_TUns8* GHOST_getClipboard(int selection);
832
833 /**
834  * Put data to the Clipboard
835  * @param       set the selection instead, X11 only feature
836  */
837 extern void GHOST_putClipboard(GHOST_TInt8 *buffer, int selection);
838
839
840 #ifdef __cplusplus
841 }
842 #endif
843
844 #endif