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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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 <plib/pu.h>
  37
  38 #include <simgear/structure/exception.hxx>
  39
  40 #define TR_HIRES_SNAP   1
  41
  42
  43 // gui.cxx
  44 extern void guiInit();
  45 extern void mkDialog(const char *txt);
  46 extern void guiErrorMessage(const char *txt);
  47 extern void guiErrorMessage(const char *txt, const sg_throwable &throwable);
  48
  49 extern bool fgDumpSnapShot();
  50 extern void fgDumpSceneGraph();
  51 extern void fgDumpTerrainBranch();
  52
  53 extern puFont guiFnt;
  54 extern fntTexFont *guiFntHandle;
  55 extern int gui_menu_on;
  56
  57 // from gui_funcs.cxx
  58 extern void reInit(puObject *);
  59 extern void fgDumpSnapShotWrapper(puObject *);
  60 #ifdef TR_HIRES_SNAP
  61 extern void fgHiResDumpWrapper(puObject *);
  62 extern void fgHiResDump();
  63 #endif
  64 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined(__MINGW32__)
  65 extern void printScreen(puObject *);
  66 #endif
  67 extern void helpCb(puObject *);
  68
  69 typedef struct {
  70         const char *name;
  71         void (*fn)(puObject *);
  72 } __fg_gui_fn_t;
  73 extern const __fg_gui_fn_t __fg_gui_fn[];
  74
  75 // GLOBAL COMMON DIALOG BOX TEXT STRINGS
  76 extern const char *gui_msg_OK;     // "OK"
  77 extern const char *gui_msg_NO;     // "NO"
  78 extern const char *gui_msg_YES;    // "YES"
  79 extern const char *gui_msg_CANCEL; // "CANCEL"
  80 extern const char *gui_msg_RESET;  // "RESET"
  81
  82 // mouse.cxx
  83 extern void guiInitMouse(int width, int height);
  84 extern void maybeToggleMouse( void );
  85 extern void TurnCursorOn( void );
  86 extern void TurnCursorOff( void );
  87
  88 // MACROS TO HELP KEEP PUI LIVE INTERFACE STACK IN SYNC
  89 // These insure that the mouse is active when dialog is shown
  90 // and try to the maintain the original mouse state when hidden
  91 // These will also repair any damage done to the Panel if active
  92
  93 // Activate Dialog Box
  94 inline void FG_PUSH_PUI_DIALOG( puObject *X ) {
  95     maybeToggleMouse();
  96     puPushLiveInterface( (puInterface *)X ) ;
  97     X->reveal() ;
  98 }
  99
 100 // Deactivate Dialog Box
 101 inline void FG_POP_PUI_DIALOG( puObject *X ) {
 102     X->hide();
 103     puPopLiveInterface();
 104     maybeToggleMouse();
 105 }
 106
 107 // Finalize Dialog Box Construction
 108 inline void FG_FINALIZE_PUI_DIALOG( puObject *X ) {
 109     ((puGroup *)X)->close();
 110     X->hide();
 111     puPopLiveInterface();
 112 }
 113
 114 #endif // _GUI_H_