1 // dialog.hxx - XML-configured dialog box.
7 # error This library requires C++
10 #include <plib/puAux.h>
12 #include <simgear/compiler.h> // for SG_USING_STD
13 #include <simgear/props/props.hxx>
14 #include <simgear/misc/sg_path.hxx>
20 // ugly temporary workaround for plib's lack of user defined class ids FIXME
21 #define FGCLASS_LIST 0x00000001
22 #define FGCLASS_AIRPORTLIST 0x00000002
23 #define FGCLASS_PROPERTYLIST 0x00000004
24 class GUI_ID { public: GUI_ID(int id) : id(id) {} virtual ~GUI_ID() {} int id; };
34 * An XML-configured dialog box.
36 * The GUI manager stores only the property tree for the dialog
37 * boxes. This class creates a PUI dialog box on demand from
38 * the properties in that tree. The manager recreates the dialog
39 * every time it needs to show it.
46 * Construct a new GUI widget configured by a property tree.
48 * The configuration properties are not part of the main
49 * FlightGear property tree; the GUI manager reads them
50 * from individual configuration files.
52 * @param props A property tree describing the dialog.
54 FGDialog (SGPropertyNode * props);
64 * Update the values of all GUI objects with a specific name,
65 * or all if name is 0 (default).
67 * This method copies values from the FlightGear property tree to
70 * @param objectName The name of the GUI object(s) to update.
71 * Use the empty name for all unnamed objects.
73 virtual void updateValues (const char * objectName = 0);
77 * Apply the values of all GUI objects with a specific name,
78 * or all if name is 0 (default)
80 * This method copies values from the GUI object(s) to the
81 * FlightGear property tree.
83 * @param objectName The name of the GUI object(s) to update.
84 * Use the empty name for all unnamed objects.
86 virtual void applyValues (const char * objectName = 0);
90 * Update state. Called on active dialogs before rendering.
92 virtual void update ();
106 // Private copy constructor to avoid unpleasant surprises.
107 FGDialog (const FGDialog &);
110 void display (SGPropertyNode * props);
112 // Build the dialog or a subobject of it.
113 puObject * makeObject (SGPropertyNode * props,
114 int parentWidth, int parentHeight);
116 // Common configuration for all GUI objects.
117 void setupObject (puObject * object, SGPropertyNode * props);
119 // Common configuration for all GUI group objects.
120 void setupGroup (puGroup * group, SGPropertyNode * props,
121 int width, int height, bool makeFrame = false);
123 // Set object colors: the "which" argument defines which color qualities
124 // (PUCOL_LABEL, etc.) should pick up the <color> property.
125 void setColor(puObject * object, SGPropertyNode * props, int which = 0);
127 // return key code number for keystring
128 int getKeyCode(const char *keystring);
130 // The top-level PUI object.
133 // The GUI subsystem.
136 // The dialog font. Defaults to the global gui font, but can get
137 // overridden by a top level font definition.
140 // The source xml tree, so that we can pass data back, such as the
142 SGPropertyNode_ptr _props;
146 SGPropertyNode_ptr _nasal_close;
148 // PUI provides no way for userdata to be deleted automatically
149 // with a GUI object, so we have to keep track of all the special
150 // data we allocated and then free it manually when the dialog
152 vector<void *> _info;
153 struct PropertyObject {
154 PropertyObject (const char * name,
156 SGPropertyNode_ptr node);
159 SGPropertyNode_ptr node;
161 vector<PropertyObject *> _propertyObjects;
162 vector<PropertyObject *> _liveObjects;
166 // Custom subclass of puPopup to implement "draggable" windows in the
167 // interface. Note that this is a subclass of puPopup, not
168 // puDialogBox. Sadly, PUI (mis)uses subclassing to implement a
169 // boolean property: modality. That means that we can't implement
170 // dragging of both puPopup windows and puDialogBoxes with the same
171 // code. Rather than duplicate code, I've chosen to implement only
172 // "non-modal dragability" here. Modal dialog boxes (like the exit
173 // confirmation) are not draggable.
175 class fgPopup : public puPopup {
177 fgPopup(int x, int y, bool r = true, bool d = true) :
178 puPopup(x, y), _draggable(d), _resizable(r), _dragging(false)
180 int checkHit(int b, int up, int x, int y);
181 int checkKey(int key, int updown);
182 int getHitObjects(puObject *, int x, int y);
183 puObject *getKeyObject(puObject *, int key);
184 puObject *getActiveInputField(puObject *);
185 void applySize(puObject *);
187 enum { LEFT = 1, RIGHT = 2, TOP = 4, BOTTOM = 8 };
194 int _dlgX, _dlgY, _dlgW, _dlgH;
195 int _startX, _startY;
201 fgValueList(SGPropertyNode *p);
202 virtual ~fgValueList();
203 virtual void update();
211 SGPropertyNode_ptr _props;
215 class fgList : public fgValueList, public puaList, public GUI_ID {
217 fgList(int x1, int y1, int x2, int y2, SGPropertyNode *p, int sw) :
218 fgValueList(p), puaList(x1, y1, x2, y2, _list, sw), GUI_ID(FGCLASS_LIST) {}
222 class fgComboBox : public fgValueList, public puaComboBox {
224 fgComboBox(int x1, int y1, int x2, int y2, SGPropertyNode *p, bool editable) :
225 fgValueList(p), puaComboBox(x1, y1, x2, y2, _list, editable) {}
228 class fgSelectBox : public fgValueList, public puaSelectBox {
230 fgSelectBox(int x1, int y1, int x2, int y2, SGPropertyNode *p) :
231 fgValueList(p), puaSelectBox(x1, y1, x2, y2, _list) {}
234 #endif // __DIALOG_HXX