]> git.mxchange.org Git - flightgear.git/blobdiff - src/GUI/dialog.hxx
Autopilot: clean up the helpers code (which drives the various /internal/) properties...
[flightgear.git] / src / GUI / dialog.hxx
index de2e900a907ace5014336e05cfe72c4ebe43f6a0..63aef704b1d2ec3354c7b4261749a2054db43515 100644 (file)
@@ -1,4 +1,4 @@
-// dialog.hxx - XML-configurable dialog box.
+// dialog.hxx - XML-configured dialog box.
 
 #ifndef __DIALOG_HXX
 #define __DIALOG_HXX 1
@@ -7,43 +7,52 @@
 # error This library requires C++
 #endif
 
-#include <plib/pu.h>
+#include <plib/puAux.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 <simgear/props/condition.hxx>
 
 #include <vector>
-SG_USING_STD(vector);
+using std::vector;
 
-class FGDialog;
-class FGBinding;
 
+// ugly temporary workaround for plib's lack of user defined class ids  FIXME
+#define FGCLASS_LIST          0x00000001
+#define FGCLASS_AIRPORTLIST   0x00000002
+#define FGCLASS_PROPERTYLIST  0x00000004
+class GUI_ID { public: GUI_ID(int id) : id(id) {} virtual ~GUI_ID() {} int id; };
 
-/**
- * PUI userdata describing a GUI object.
- */
-struct GUIInfo
-{
-    GUIInfo (FGDialog * w);
-    virtual ~GUIInfo ();
-    
-    FGDialog * widget;
-    vector <FGBinding *> bindings;
-};
+
+
+class FGDialog;
+class NewGUI;
+class FGColor;
 
 
 /**
- * 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);
 
 
     /**
@@ -53,55 +62,111 @@ public:
 
 
     /**
-     * Update the values of all GUI objects with a specific name.
+     * Update the values of all GUI objects with a specific name,
+     * or all if name is 0 (default).
      *
-     * 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.
      */
-    virtual void updateValue (const char * objectName);
+    virtual void updateValues (const char * objectName = 0);
 
 
     /**
-     * Apply the values of all GUI objects with a specific name.
+     * Apply the values of all GUI objects with a specific name,
+     * or all if name is 0 (default)
      *
-     * 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.
      */
-    virtual void applyValue (const char * objectName);
+    virtual void applyValues (const char * objectName = 0);
 
 
     /**
-     * Update the values of all GUI objects.
-     *
-     * This method copies from the properties to the GUI objects.
+     * Update state.  Called on active dialogs before rendering.
      */
-    virtual void updateValues ();
-
+    virtual void update ();
 
     /**
-     * Apply the values of all GUI objects.
-     *
-     * This method copies from the GUI objects to the properties.
+     * Recompute the dialog's layout
      */
-    virtual void applyValues ();
+    void relayout();
+    
+    
+    void setNeedsLayout() {
+      _needsRelayout = true;
+    }
+private:
+
+    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 &);
 
-private:
-    FGDialog (const FGDialog &); // just for safety
+    // Show the dialog.
+    void display (SGPropertyNode * props);
 
-    void display (SGPropertyNode_ptr 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);
+
+    /**
+     * Apply layout sizes to a tree of puObjects
+     */
+    void applySize(puObject *object);
+
+    // 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;
+
+    bool _needsRelayout;
+
+    // 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,
@@ -111,6 +176,96 @@ private:
         SGPropertyNode_ptr node;
     };
     vector<PropertyObject *> _propertyObjects;
+    vector<PropertyObject *> _liveObjects;
+    
+    class ConditionalObject : public SGConditional
+    {
+    public:
+      ConditionalObject(const std::string& aName, puObject* aPu) :
+        _name(aName),
+        _pu(aPu)
+      { ; }
+    
+      void update(FGDialog* aDlg);
+    
+    private:
+      const std::string _name;
+      puObject* _pu;      
+    };
+    
+    typedef SGSharedPtr<ConditionalObject> ConditionalObjectRef;
+    vector<ConditionalObjectRef> _conditionalObjects;
+};
+
+//
+// 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 r = true, bool d = true) :
+            puPopup(x, y), _draggable(d), _resizable(r), _dragging(false)
+    {}
+    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 *);
+    void applySize(puObject *);
+private:
+    enum { LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
+    bool _draggable;
+    bool _resizable;
+    bool _dragging;
+    int _resizing;
+    int _start_cursor;
+    int _cursor;
+    int _dlgX, _dlgY, _dlgW, _dlgH;
+    int _startX, _startY;
+};
+
+
+class fgValueList {
+public:
+    fgValueList(SGPropertyNode *p);
+    virtual ~fgValueList();
+    virtual void update();
+
+protected:
+    char **_list;
+
+private:
+    void make_list();
+    void destroy_list();
+    SGPropertyNode_ptr _props;
+};
+
+
+class fgList : public fgValueList, public puaList, public GUI_ID {
+public:
+    fgList(int x1, int y1, int x2, int y2, SGPropertyNode *p, int sw) :
+            fgValueList(p), puaList(x1, y1, x2, y2, _list, sw), GUI_ID(FGCLASS_LIST) {}
+    void update();
+};
+
+class fgComboBox : public fgValueList, public puaComboBox {
+public:
+    fgComboBox(int x1, int y1, int x2, int y2, SGPropertyNode *p, bool editable) :
+        fgValueList(p), puaComboBox(x1, y1, x2, y2, _list, editable) {}
+        
+    void update();
+};
+
+class fgSelectBox : public fgValueList, public puaSelectBox {
+public:
+    fgSelectBox(int x1, int y1, int x2, int y2, SGPropertyNode *p) :
+        fgValueList(p), puaSelectBox(x1, y1, x2, y2, _list) {}
 };
 
 #endif // __DIALOG_HXX