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/props/props.hxx>
14 #include <simgear/structure/subsystem_mgr.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 found in $FG_ROOT/gui/dialogs/. It
36 * can show or hide the menubar, and can display any dialog by name.
38 class NewGUI : public SGSubsystem
53 * Initialize the GUI subsystem.
58 * Reinitialize the GUI subsystem.
60 virtual void reinit ();
63 * Bind properties for the GUI subsystem.
65 * Currently, this method binds the properties for showing and
71 * Unbind properties for the GUI subsystem.
73 virtual void unbind ();
76 * Update the GUI subsystem.
78 * Currently, this method is a no-op, because nothing the GUI
79 * subsystem does is time-dependent.
81 virtual void update (double delta_time_sec);
84 * Creates a new dialog box, using the same property format as the
85 * gui/dialogs configuration files. Does not display the
86 * resulting dialog. If a pre-existing dialog of the same name
87 * exists, it will be deleted. The node argument will be stored
88 * in the GUI subsystem using SGPropertNode_ptr reference counting.
89 * It should not be deleted by user code.
91 * @param node A property node containing the dialog definition
93 virtual void newDialog (SGPropertyNode* node);
96 * Display a dialog box.
98 * At initialization time, the subsystem reads all of the XML
99 * configuration files from the directory $FG_ROOT/gui/dialogs/.
100 * The configuration for each dialog specifies a name, and this
101 * method invokes the dialog with the name specified (if it
104 * @param name The name of the dialog box.
105 * @return true if the dialog exists, false otherwise.
107 virtual bool showDialog (const string &name);
111 * Close the currenty active dialog. This function is intended to
112 * be called from code (pui callbacks, for instance) that registers
113 * its dialog object as active via setActiveDialog(). Other
114 * user-level code should use the closeDialog(name) API.
116 * @return true if a dialog was active, false otherwise
118 virtual bool closeActiveDialog ();
121 * Close a named dialog, if it is open.
123 * @param name The name of the dialog box.
124 * @return true if the dialog was active, false otherwise.
126 virtual bool closeDialog (const string &name);
129 * Return a pointer to the current menubar.
131 virtual FGMenuBar * getMenuBar ();
135 * Ignore this method.
137 * This method is for internal use only, but it has to be public
138 * so that a non-class callback can see it.
140 virtual void setActiveDialog (FGDialog * dialog);
143 * Get the dialog currently active, if any.
145 * @return The active dialog, or 0 if none is active.
147 virtual FGDialog * getActiveDialog ();
152 * Test if the menubar is visible.
154 * This method exists only for binding.
156 virtual bool getMenuBarVisible () const;
159 * Show or hide the menubar.
161 * This method exists only for binding.
163 virtual void setMenuBarVisible (bool visible);
168 // Free all allocated memory.
171 // Read all the configuration files in a directory.
172 void readDir (const char * path);
174 FGMenuBar * _menubar;
175 FGDialog * _active_dialog;
176 map<string,FGDialog *> _active_dialogs;
177 map<string,SGPropertyNode_ptr> _dialog_props;
182 #endif // __NEW_GUI_HXX