src/GUI/gui.h

   1 /**************************************************************************
   2  * gui.h
   3  *
   4  * Written 1998 by Durk Talsma, started Juni, 1998.  For the flight gear
   5  * project.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * $Id$
  22  **************************************************************************/
  23
  24
  25 #ifndef _GUI_H_
  26 #define _GUI_H_
  27
  28 #ifdef HAVE_CONFIG_H
  29 #  include <config.h>
  30 #endif
  31
  32 #ifdef HAVE_WINDOWS_H
  33 #  include <windows.h>
  34 #endif
  35
  36 #include FG_GLUT_H              // needed before pu.h
  37
  38 #include <plib/pu.h>            // plib include
  39
  40 #include <simgear/structure/exception.hxx>
  41
  42 #define TR_HIRES_SNAP   1
  43
  44
  45 // gui.cxx
  46 extern void guiInit();
  47 extern void mkDialog(const char *txt);
  48 extern void guiErrorMessage(const char *txt);
  49 extern void guiErrorMessage(const char *txt, const sg_throwable &throwable);
  50 extern void ConfirmExitDialog(void);
  51
  52 extern void fgDumpSnapShot();
  53
  54 extern puFont guiFnt;
  55 extern fntTexFont *guiFntHandle;
  56 extern int gui_menu_on;
  57
  58 // from gui_funcs.cxx
  59 extern void saveFlight(puObject *);
  60 extern void loadFlight(puObject *);
  61 extern void reInit(puObject *);
  62 extern void dumpSnapShot(puObject *);
  63 #ifdef TR_HIRES_SNAP
  64 extern void dumpHiResSnapShot(puObject *);
  65 #endif
  66 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined(__MINGW32__)
  67 extern void printScreen(puObject *);
  68 #endif
  69 extern void MayBeGoodBye(puObject *);
  70 extern void guiTogglePanel(puObject *);
  71 extern void PilotOffsetAdjust(puObject *);
  72 extern void fgHUDalphaAdjust(puObject *);
  73 extern void prop_pickerView(puObject *);
  74 extern void NewAirport(puObject *);
  75 #ifdef FG_NETWORK_OLK
  76 extern void net_display_toggle(puObject *);
  77 extern void NewCallSign(puObject *);
  78 extern void net_fgd_scan(puObject *);
  79 extern void net_register(puObject *);
  80 extern void net_unregister(puObject *);
  81 #endif
  82 extern void NewAltitude(puObject *);
  83 extern void AddWayPoint(puObject *);
  84 extern void PopWayPoint(puObject *);
  85 extern void ClearRoute(puObject *);
  86 extern void fgAPAdjust(puObject *);
  87 extern void fgLatLonFormatToggle(puObject *);
  88 extern void helpCb(puObject *);
  89 extern void fgReshape(int, int);
  90
  91 typedef struct {
  92         char *name;
  93         void (*fn)(puObject *);
  94 } __fg_gui_fn_t;
  95 extern const __fg_gui_fn_t __fg_gui_fn[];
  96
  97 // GLOBAL COMMON DIALOG BOX TEXT STRINGS
  98 extern char *gui_msg_OK;     // "OK"
  99 extern char *gui_msg_NO;     // "NO"
 100 extern char *gui_msg_YES;    // "YES"
 101 extern char *gui_msg_CANCEL; // "CANCEL"
 102 extern char *gui_msg_RESET;  // "RESET"
 103
 104 // mouse.cxx
 105 extern void guiInitMouse(int width, int height);
 106 extern void guiMotionFunc ( int x, int y );
 107 extern void guiMouseFunc(int button, int updown, int x, int y);
 108 extern void maybeToggleMouse( void );
 109 extern void BusyCursor( int restore );
 110 extern void CenterView( void );
 111 extern void TurnCursorOn( void );
 112 extern void TurnCursorOff( void );
 113
 114 // MACROS TO HELP KEEP PUI LIVE INTERFACE STACK IN SYNC
 115 // These insure that the mouse is active when dialog is shown
 116 // and try to the maintain the original mouse state when hidden
 117 // These will also repair any damage done to the Panel if active
 118
 119 // Activate Dialog Box
 120 inline void FG_PUSH_PUI_DIALOG( puObject *X ) {
 121     maybeToggleMouse();
 122     puPushLiveInterface( (puInterface *)X ) ;
 123     X->reveal() ;
 124 }
 125
 126 // Deactivate Dialog Box
 127 inline void FG_POP_PUI_DIALOG( puObject *X ) {
 128     X->hide();
 129     puPopLiveInterface();
 130     maybeToggleMouse();
 131 }
 132
 133 // Finalize Dialog Box Construction
 134 inline void FG_FINALIZE_PUI_DIALOG( puObject *X ) {
 135     ((puGroup *)X)->close();
 136     X->hide();
 137     puPopLiveInterface();
 138 }
 139
 140 #endif // _GUI_H_