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