-// new_gui.hxx - XML-configurable GUI subsystem.
+// new_gui.hxx - XML-configured GUI subsystem.
#ifndef __NEW_GUI_HXX
#define __NEW_GUI_HXX 1
#include <plib/pu.h>
#include <simgear/compiler.h> // for SG_USING_STD
-#include <simgear/misc/props.hxx>
+#include <simgear/props/props.hxx>
#include <vector>
SG_USING_STD(vector);
#include <Main/fgfs.hxx>
#include <Main/fg_props.hxx>
-#include <Input/input.hxx>
-class GUIWidget;
+class FGMenuBar;
+class FGDialog;
+class FGBinding;
/**
- * Information about a GUI widget.
+ * XML-configured GUI subsystem.
+ *
+ * This subsystem manages the graphical user interface for FlightGear.
+ * It creates a menubar from the XML configuration file in
+ * $FG_ROOT/gui/menubar.xml, then stores the configuration properties
+ * for XML-configured dialog boxes found in $FG_ROOT/gui/dialogs/. It
+ * can show or hide the menubar, and can display any dialog by name.
*/
-struct GUIInfo
-{
- GUIInfo (GUIWidget * w);
- virtual ~GUIInfo ();
-
- GUIWidget * widget;
- vector <FGBinding *> bindings;
-};
-
-
-/**
- * Top-level GUI widget.
- */
-class GUIWidget
+class NewGUI : public FGSubsystem
{
public:
-
/**
- * Construct a new GUI widget configured by a property tree.
+ * Constructor.
*/
- GUIWidget (SGPropertyNode_ptr props);
-
+ NewGUI ();
/**
* Destructor.
*/
- virtual ~GUIWidget ();
+ virtual ~NewGUI ();
+ /**
+ * Initialize the GUI subsystem.
+ */
+ virtual void init ();
/**
- * Update the values of all GUI objects with a specific name.
- *
- * This method copies from the property to the GUI object.
+ * Reinitialize the GUI subsystem.
+ */
+ virtual void reinit ();
+
+ /**
+ * Bind properties for the GUI subsystem.
*
- * @param objectName The name of the GUI object(s) to update.
- * Use the empty name for all unnamed objects.
+ * Currently, this method binds the properties for showing and
+ * hiding the menu.
*/
- virtual void updateValue (const char * objectName);
+ virtual void bind ();
+ /**
+ * Unbind properties for the GUI subsystem.
+ */
+ virtual void unbind ();
/**
- * Apply the values of all GUI objects with a specific name.
+ * Update the GUI subsystem.
*
- * This method copies from the GUI object to the property.
+ * Currently, this method is a no-op, because nothing the GUI
+ * subsystem does is time-dependent.
+ */
+ virtual void update (double delta_time_sec);
+
+ /**
+ * Display a dialog box.
*
- * @param objectName The name of the GUI object(s) to update.
- * Use the empty name for all unnamed objects.
+ * At initialization time, the subsystem reads all of the XML
+ * configuration files from the directory $FG_ROOT/gui/dialogs/.
+ * The configuration for each dialog specifies a name, and this
+ * method invokes the dialog with the name specified (if it
+ * exists).
+ *
+ * @param name The name of the dialog box.
+ * @return true if the dialog exists, false otherwise.
*/
- virtual void applyValue (const char * objectName);
+ virtual bool showDialog (const string &name);
/**
- * Update the values of all GUI objects.
+ * Close the currently-active dialog, if any.
*
- * This method copies from the properties to the GUI objects.
+ * @return true if a dialog was active, false otherwise.
*/
- virtual void updateValues ();
+ virtual bool closeActiveDialog ();
/**
- * Apply the values of all GUI objects.
- *
- * This method copies from the GUI objects to the properties.
+ * Return a pointer to the current menubar.
*/
- virtual void applyValues ();
+ virtual FGMenuBar * getMenuBar ();
-private:
- GUIWidget (const GUIWidget &); // just for safety
-
- void display (SGPropertyNode_ptr props);
- puObject * makeObject (SGPropertyNode * props,
- int parentWidth, int parentHeight);
- void setupObject (puObject * object, SGPropertyNode * props);
- void setupGroup (puGroup * group, SGPropertyNode * props,
- int width, int height, bool makeFrame = false);
-
- puObject * _object;
- vector<GUIInfo *> _info;
- struct PropertyObject {
- PropertyObject (const char * name,
- puObject * object,
- SGPropertyNode_ptr node);
- string name;
- puObject * object;
- SGPropertyNode_ptr node;
- };
- vector<PropertyObject *> _propertyObjects;
-};
+ /**
+ * Ignore this method.
+ *
+ * This method is for internal use only, but it has to be public
+ * so that a non-class callback can see it.
+ */
+ virtual void setActiveDialog (FGDialog * dialog);
+ /**
+ * Get the dialog currently active, if any.
+ *
+ * @return The active dialog, or 0 if none is active.
+ */
+ virtual FGDialog * getActiveDialog ();
-class NewGUI : public FGSubsystem
-{
-public:
+protected:
- NewGUI ();
- virtual ~NewGUI ();
- virtual void init ();
- virtual void update (double delta_time_sec);
- virtual void display (const string &name);
+ /**
+ * Test if the menubar is visible.
+ *
+ * This method exists only for binding.
+ */
+ virtual bool getMenuBarVisible () const;
- virtual void setCurrentWidget (GUIWidget * widget);
- virtual GUIWidget * getCurrentWidget ();
+ /**
+ * Show or hide the menubar.
+ *
+ * This method exists only for binding.
+ */
+ virtual void setMenuBarVisible (bool visible);
private:
+ // Free all allocated memory.
+ void clear ();
+
+ // Read all the configuration files in a directory.
void readDir (const char * path);
- GUIWidget * _current_widget;
- map<string,SGPropertyNode_ptr> _widgets;
+ FGMenuBar * _menubar;
+ FGDialog * _active_dialog;
+ map<string,SGPropertyNode *> _dialog_props;
};
#endif // __NEW_GUI_HXX
-// end of new_gui.hxx
projects / flightgear.git / blobdiff