-// new_gui.hxx - XML-configurable GUI subsystem.
+// new_gui.hxx - XML-configured GUI subsystem.
#ifndef __NEW_GUI_HXX
#define __NEW_GUI_HXX 1
# error This library requires C++
#endif
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
#include <plib/pu.h>
#include <simgear/compiler.h> // for SG_USING_STD
-#include <simgear/misc/props.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
#include <vector>
SG_USING_STD(vector);
#include <map>
SG_USING_STD(map);
-#include <Main/fgfs.hxx>
#include <Main/fg_props.hxx>
-#include <Input/input.hxx>
-class GUIWidget;
+class FGMenuBar;
+class FGDialog;
+class FGBinding;
+class FGColor;
/**
- * 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
+class NewGUI : public SGSubsystem
{
- GUIInfo (GUIWidget * w);
- virtual ~GUIInfo ();
+public:
- GUIWidget * widget;
- vector <FGBinding *> bindings;
-};
+ /**
+ * Constructor.
+ */
+ NewGUI ();
+ /**
+ * Destructor.
+ */
+ virtual ~NewGUI ();
-/**
- * Top-level GUI widget.
- */
-class GUIWidget
-{
-public:
+ /**
+ * Initialize the GUI subsystem.
+ */
+ virtual void init ();
+ /**
+ * Reinitialize the GUI subsystem.
+ */
+ virtual void reinit ();
/**
- * Construct a new GUI widget configured by a property tree.
+ * Bind properties for the GUI subsystem.
+ *
+ * Currently, this method binds the properties for showing and
+ * hiding the menu.
*/
- GUIWidget (SGPropertyNode_ptr props);
+ virtual void bind ();
+ /**
+ * Unbind properties for the GUI subsystem.
+ */
+ virtual void unbind ();
/**
- * Destructor.
+ * Update the GUI subsystem.
+ *
+ * Currently, this method is a no-op, because nothing the GUI
+ * subsystem does is time-dependent.
*/
- virtual ~GUIWidget ();
+ virtual void update (double delta_time_sec);
+ /**
+ * Creates a new dialog box, using the same property format as the
+ * gui/dialogs configuration files. Does not display the
+ * resulting dialog. If a pre-existing dialog of the same name
+ * exists, it will be deleted. The node argument will be stored
+ * in the GUI subsystem using SGPropertNode_ptr reference counting.
+ * It should not be deleted by user code.
+ *
+ * @param node A property node containing the dialog definition
+ */
+ virtual void newDialog (SGPropertyNode* node);
/**
- * Update the values of all GUI objects with a specific name.
+ * Display a dialog box.
*
- * This method copies from the property to the GUI object.
+ * 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 objectName The name of the GUI object(s) to update.
- * Use the empty name for all unnamed objects.
+ * @param name The name of the dialog box.
+ * @return true if the dialog exists, false otherwise.
*/
- virtual void updateValue (const char * objectName);
+ virtual bool showDialog (const string &name);
/**
- * Apply the values of all GUI objects with a specific name.
- *
- * This method copies from the GUI object to the property.
+ * Close the currenty active dialog. This function is intended to
+ * be called from code (pui callbacks, for instance) that registers
+ * its dialog object as active via setActiveDialog(). Other
+ * user-level code should use the closeDialog(name) API.
*
- * @param objectName The name of the GUI object(s) to update.
- * Use the empty name for all unnamed objects.
+ * @return true if a dialog was active, false otherwise
*/
- virtual void applyValue (const char * objectName);
-
+ virtual bool closeActiveDialog ();
/**
- * Update the values of all GUI objects.
+ * Close a named dialog, if it is open.
*
- * This method copies from the properties to the GUI objects.
+ * @param name The name of the dialog box.
+ * @return true if the dialog was active, false otherwise.
+ */
+ virtual bool closeDialog (const string &name);
+
+ /**
+ * Return a pointer to the current menubar.
*/
- virtual void updateValues ();
+ virtual FGMenuBar * getMenuBar ();
/**
- * Apply the values of all GUI objects.
+ * Ignore this method.
*
- * This method copies from the GUI objects to the properties.
+ * This method is for internal use only, but it has to be public
+ * so that a non-class callback can see it.
*/
- virtual void applyValues ();
+ 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 ();
-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;
-};
-
+ const FGColor& getColor (const char * which) { return _colors[which]; }
+ const FGColor& getColor (string which) { return _colors[which.c_str()]; }
-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);
+ virtual void setStyle ();
+ virtual void setupFont ();
private:
+ fntTexFont _tex_font;
+ puFont _font;
+ map<string,FGColor> _colors;
+ // 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,FGDialog *> _active_dialogs;
+ map<string,SGPropertyNode_ptr> _dialog_props;
+
+};
+
+class FGColor {
+public:
+ FGColor() { clear(); }
+ FGColor(float r, float g, float b, float a = 1.0f) { set(r, g, b, a); }
+ FGColor(const SGPropertyNode *prop) { set(prop); }
+
+ FGColor& operator=(const FGColor& c) {
+ _red = c._red;
+ _green = c._green;
+ _blue = c._blue;
+ _alpha = c._alpha;
+ return *this;
+ }
+
+ inline void clear() { _red = _green = _blue = -1.0f; _alpha = 1.0f; }
+ // merges in non-negative components from property with children <red> etc.
+ void merge(const SGPropertyNode *prop);
+ void merge(const FGColor& color);
+
+ void set(const SGPropertyNode *prop) { clear(); merge(prop); };
+ void set(const FGColor& color) { clear(); merge(color); }
+ void set(float r, float g, float b, float a = 1.0f) {
+ _red = clamp(r), _green = clamp(g), _blue = clamp(b), _alpha = clamp(a);
+ }
+ bool isValid() const {
+ return _red >= 0.0 && _green >= 0.0 && _blue >= 0.0
+ && _alpha >= 0.0;
+ }
+ void print() const {
+ std::cerr << "red=" << _red << ", green=" << _green
+ << ", blue=" << _blue << ", alpha=" << _alpha << std::endl;
+ }
+
+ inline void setRed(float red) { _red = clamp(red); }
+ inline void setGreen(float green) { _green = clamp(green); }
+ inline void setBlue(float blue) { _blue = clamp(blue); }
+ inline void setAlpha(float alpha) { _alpha = clamp(alpha); }
+
+ inline float red() const { return _red; }
+ inline float green() const { return _green; }
+ inline float blue() const { return _blue; }
+ inline float alpha() const { return _alpha; }
+
+protected:
+ float _red, _green, _blue, _alpha;
+
+private:
+ float clamp(float f) { return f < 0.0 ? 0.0 : f > 1.0 ? 1.0 : f; }
};
#endif // __NEW_GUI_HXX
-// end of new_gui.hxx
projects / flightgear.git / blobdiff