1 // new_gui.hxx - XML-configured GUI subsystem.
4 #define __NEW_GUI_HXX 1
6 #include <simgear/props/props.hxx>
7 #include <simgear/structure/subsystem_mgr.hxx>
8 #include <simgear/misc/sg_path.hxx>
14 #include <memory> // for auto_ptr on some systems
25 * XML-configured GUI subsystem.
27 * This subsystem manages the graphical user interface for FlightGear.
28 * It creates a menubar from the XML configuration file in
29 * $FG_ROOT/gui/menubar.xml, then stores the configuration properties
30 * for XML-configured dialog boxes found in $FG_ROOT/gui/dialogs/. It
31 * can show or hide the menubar, and can display any dialog by name.
33 class NewGUI : public SGSubsystem
48 * Initialize the GUI subsystem.
53 * Reinitialize the GUI subsystem. Reloads all XML dialogs.
55 virtual void reinit ();
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 * Redraw the GUI picking up new GUI colors.
81 virtual void redraw ();
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 std::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 std::string &name);
129 * Get dialog property tree's root node.
130 * @param name The name of the dialog box.
131 * @return node pointer if the dialog was found, zero otherwise.
133 virtual SGPropertyNode_ptr getDialogProperties (const std::string &name);
136 * Return a pointer to the current menubar.
138 virtual FGMenuBar * getMenuBar ();
141 * Ignore this method.
143 * This method is for internal use only, but it has to be public
144 * so that a non-class callback can see it.
146 virtual void setActiveDialog (FGDialog * dialog);
149 * Get the dialog currently active, if any.
151 * @return The active dialog, or 0 if none is active.
153 virtual FGDialog * getActiveDialog ();
157 * Get the named dialog if active.
159 * @return The named dialog, or 0 if it isn't active.
161 virtual FGDialog * getDialog (const std::string &name);
164 virtual FGColor *getColor (const char * name) const {
165 _citt_t it = _colors.find(name);
166 return (it != _colors.end()) ? it->second : NULL;
168 virtual FGColor *getColor (const std::string &name) const {
169 _citt_t it = _colors.find(name.c_str());
170 return (it != _colors.end()) ? it->second : NULL;
173 virtual puFont *getDefaultFont() { return _font; }
179 * Test if the menubar is visible.
181 * This method exists only for binding.
183 virtual bool getMenuBarVisible () const;
186 * Show or hide the menubar.
188 * This method exists only for binding.
190 virtual void setMenuBarVisible (bool visible);
192 virtual void setStyle ();
193 virtual void setupFont (SGPropertyNode *);
196 * Used by reinit() and redraw() to close all dialogs and to apply
197 * current GUI colors. If "reload" is false, reopens all dialogs.
198 * Otherwise reloads all XML dialog files from disk and reopens all
199 * but Nasal * generated dialogs, omitting dynamic widgets. (This
200 * is only useful for GUI development.)
202 virtual void reset (bool reload);
207 bool operator()(const char* s1, const char* s2) const {
208 return strcmp(s1, s2) < 0;
213 typedef std::map<const char*,FGColor*, ltstr> ColourDict;
215 typedef ColourDict::iterator _itt_t;
216 typedef ColourDict::const_iterator _citt_t;
220 // Read all the configuration files in a directory.
221 void readDir (const SGPath& path);
223 std::auto_ptr<FGMenuBar> _menubar;
224 FGDialog * _active_dialog;
225 std::map<std::string,FGDialog *> _active_dialogs;
226 std::map<std::string,SGPropertyNode_ptr> _dialog_props;
231 #endif // __NEW_GUI_HXX