1 // new_gui.hxx - XML-configured GUI subsystem.
4 #define __NEW_GUI_HXX 1
7 # error This library requires C++
12 #include <simgear/compiler.h> // for SG_USING_STD
13 #include <simgear/misc/props.hxx>
21 #include <Main/fgfs.hxx>
22 #include <Main/fg_props.hxx>
30 * XML-configured GUI subsystem.
32 * This subsystem manages the graphical user interface for FlightGear.
33 * It creates a menubar from the XML configuration file in
34 * $FG_ROOT/gui/menubar.xml, then stores the configuration properties
35 * for XML-configured dialog boxes in $FG_ROOT/gui/dialogs/*. It
36 * can show or hide the menubar, and can display any dialog by name.
38 class NewGUI : public FGSubsystem
53 * Initialize the GUI subsystem.
58 * Bind properties for the GUI subsystem.
60 * Currently, this method binds the properties for showing and
66 * Unbind properties for the GUI subsystem.
68 virtual void unbind ();
71 * Update the GUI subsystem.
73 * Currently, this method is a no-op, because nothing the GUI
74 * subsystem does is time-dependent.
76 virtual void update (double delta_time_sec);
79 * Display a dialog box.
81 * At initialization time, the subsystem reads all of the XML
82 * configuration files from $FG_ROOT/gui/dialogs/*. The
83 * configuration for each dialog specifies a name, and this method
84 * invokes the dialog with the name specified (if it exists).
86 * @param name The name of the dialog box.
87 * @return true if the dialog exists, false otherwise.
89 virtual bool showDialog (const string &name);
93 * Close the currently-active dialog, if any.
95 * @return true if a dialog was active, false otherwise.
97 virtual bool closeActiveDialog ();
101 * Return a pointer to the current menubar.
103 virtual FGMenuBar * getMenuBar ();
107 * Ignore this method.
109 * This method is for internal use only, but it has to be public
110 * so that a non-class callback can see it.
112 virtual void setActiveDialog (FGDialog * dialog);
115 * Get the dialog currently active, if any.
117 * @return The active dialog, or 0 if none is active.
119 virtual FGDialog * getActiveDialog ();
124 * Test if the menubar is visible.
126 * This method exists only for binding.
128 virtual bool getMenuBarVisible () const;
131 * Show or hide the menubar.
133 * This method exists only for binding.
135 virtual void setMenuBarVisible (bool visible);
140 // Read all the configuration files in a directory.
141 void readDir (const char * path);
143 FGMenuBar * _menubar;
144 FGDialog * _active_dialog;
145 map<string,SGPropertyNode_ptr> _dialog_props;
150 #endif // __NEW_GUI_HXX