-// dialog.hxx - XML-configurable dialog box.
+// dialog.hxx - XML-configured dialog box.
#ifndef __DIALOG_HXX
#define __DIALOG_HXX 1
#endif
#include <plib/pu.h>
+#include <plib/sg.h>
#include <simgear/compiler.h> // for SG_USING_STD
-#include <simgear/misc/props.hxx>
+#include <simgear/props/props.hxx>
+#include <simgear/misc/sg_path.hxx>
#include <vector>
SG_USING_STD(vector);
class FGDialog;
class FGBinding;
+class NewGUI;
+class FGColor;
/**
- * PUI userdata describing a GUI object.
- */
-struct GUIInfo
-{
- GUIInfo (FGDialog * w);
- virtual ~GUIInfo ();
-
- FGDialog * widget;
- vector <FGBinding *> bindings;
-};
-
-
-/**
- * Top-level GUI widget.
+ * An XML-configured dialog box.
+ *
+ * The GUI manager stores only the property tree for the dialog
+ * boxes. This class creates a PUI dialog box on demand from
+ * the properties in that tree. The manager recreates the dialog
+ * every time it needs to show it.
*/
class FGDialog
{
public:
-
/**
* Construct a new GUI widget configured by a property tree.
+ *
+ * The configuration properties are not part of the main
+ * FlightGear property tree; the GUI manager reads them
+ * from individual configuration files.
+ *
+ * @param props A property tree describing the dialog.
*/
- FGDialog (SGPropertyNode_ptr props);
+ FGDialog (SGPropertyNode * props);
/**
/**
* Update the values of all GUI objects with a specific name.
*
- * This method copies from the property to the GUI object.
+ * This method copies values from the FlightGear property tree to
+ * the GUI object(s).
*
* @param objectName The name of the GUI object(s) to update.
* Use the empty name for all unnamed objects.
/**
* Apply the values of all GUI objects with a specific name.
*
- * This method copies from the GUI object to the property.
+ * This method copies values from the GUI object(s) to the
+ * FlightGear property tree.
*
* @param objectName The name of the GUI object(s) to update.
* Use the empty name for all unnamed objects.
/**
* Update the values of all GUI objects.
*
- * This method copies from the properties to the GUI objects.
+ * This method copies values from the FlightGear property tree to
+ * the GUI objects.
*/
virtual void updateValues ();
/**
* Apply the values of all GUI objects.
*
- * This method copies from the GUI objects to the properties.
+ * This method copies from the GUI objects to the FlightGear
+ * property tree properties.
*/
virtual void applyValues ();
+ /**
+ * Update state. Called on active dialogs before rendering.
+ */
+ virtual void update ();
+
private:
- FGDialog (const FGDialog &); // just for safety
- void display (SGPropertyNode_ptr props);
+ enum {
+ BACKGROUND = 0x01,
+ FOREGROUND = 0x02,
+ HIGHLIGHT = 0x04,
+ LABEL = 0x08,
+ LEGEND = 0x10,
+ MISC = 0x20,
+ EDITFIELD = 0x40
+ };
+
+ // Private copy constructor to avoid unpleasant surprises.
+ FGDialog (const FGDialog &);
+
+ // Show the dialog.
+ void display (SGPropertyNode * props);
+
+ // Build the dialog or a subobject of it.
puObject * makeObject (SGPropertyNode * props,
int parentWidth, int parentHeight);
+
+ // Common configuration for all GUI objects.
void setupObject (puObject * object, SGPropertyNode * props);
+
+ // Common configuration for all GUI group objects.
void setupGroup (puGroup * group, SGPropertyNode * props,
int width, int height, bool makeFrame = false);
+ // Set object colors: the "which" argument defines which color qualities
+ // (PUCOL_LABEL, etc.) should pick up the <color> property.
+ void setColor(puObject * object, SGPropertyNode * props, int which = 0);
+
+ // return key code number for keystring
+ int getKeyCode(const char *keystring);
+
+ // The top-level PUI object.
puObject * _object;
- vector<GUIInfo *> _info;
+
+ // The GUI subsystem.
+ NewGUI * _gui;
+
+ // The dialog font. Defaults to the global gui font, but can get
+ // overridden by a top level font definition.
+ puFont * _font;
+
+ // The source xml tree, so that we can pass data back, such as the
+ // last position.
+ SGPropertyNode_ptr _props;
+
+ // Nasal module.
+ string _module;
+ SGPropertyNode_ptr _nasal_close;
+
+ // PUI provides no way for userdata to be deleted automatically
+ // with a GUI object, so we have to keep track of all the special
+ // data we allocated and then free it manually when the dialog
+ // closes.
+ vector<void *> _info;
struct PropertyObject {
PropertyObject (const char * name,
puObject * object,
SGPropertyNode_ptr node;
};
vector<PropertyObject *> _propertyObjects;
+ vector<PropertyObject *> _liveObjects;
+
+ // PUI doesn't copy arrays, so we have to allocate string arrays
+ // and then keep pointers so that we can delete them when the
+ // dialog closes.
+ char ** make_char_array (int size);
+ vector<char **> _char_arrays;
+};
+
+//
+// Custom subclass of puPopup to implement "draggable" windows in the
+// interface. Note that this is a subclass of puPopup, not
+// puDialogBox. Sadly, PUI (mis)uses subclassing to implement a
+// boolean property: modality. That means that we can't implement
+// dragging of both puPopup windows and puDialogBoxes with the same
+// code. Rather than duplicate code, I've chosen to implement only
+// "non-modal dragability" here. Modal dialog boxes (like the exit
+// confirmation) are not draggable.
+//
+class fgPopup : public puPopup {
+public:
+ fgPopup(int x, int y, bool d = true) : puPopup(x, y) { _dragging = false; _draggable = d;}
+ int checkHit(int b, int up, int x, int y);
+ int checkKey(int key, int updown);
+ int getHitObjects(puObject *, int x, int y);
+ puObject *getKeyObject(puObject *, int key);
+ puObject *getActiveInputField(puObject *);
+private:
+ bool _draggable;
+ bool _dragging;
+ int _dX, _dY;
};
#endif // __DIALOG_HXX
projects / flightgear.git / blobdiff