1 // dialog.cxx: implementation of an XML-configurable dialog box.
3 #include <stdlib.h> // atof()
5 #include <Input/input.hxx>
11 #include "AirportList.hxx"
14 int fgPopup::checkHit(int button, int updown, int x, int y)
16 int result = puPopup::checkHit(button, updown, x, y);
21 // This is annoying. We would really want a true result from the
22 // superclass to indicate "handled by child object", but all it
23 // tells us is that the pointer is inside the dialog. So do the
24 // intersection test (again) to make sure we don't start a drag
25 // when inside controls.
27 if(updown == PU_DOWN && !_dragging) {
31 int hit = getHitObjects(this, x, y);
32 if(hit & (PUCLASS_BUTTON|PUCLASS_ONESHOT|PUCLASS_INPUT))
36 getPosition(&px, &py);
40 } else if(updown == PU_DRAG && _dragging) {
41 setPosition(x + _dX, y + _dY);
48 int fgPopup::getHitObjects(puObject *object, int x, int y)
51 if(object->getType() & PUCLASS_GROUP)
52 for (puObject *obj = ((puGroup *)object)->getFirstChild();
53 obj; obj = obj->getNextObject())
54 type |= getHitObjects(obj, x, y);
57 object->getAbsolutePosition(&cx, &cy);
58 object->getSize(&cw, &ch);
59 if(x >= cx && x < cx + cw && y >= cy && y < cy + ch)
60 type |= object->getType();
66 ////////////////////////////////////////////////////////////////////////
68 ////////////////////////////////////////////////////////////////////////
71 * User data for a GUI object.
75 GUIInfo (FGDialog * d);
79 vector <FGBinding *> bindings;
87 action_callback (puObject * object)
89 GUIInfo * info = (GUIInfo *)object->getUserData();
90 NewGUI * gui = (NewGUI *)globals->get_subsystem("gui");
91 gui->setActiveDialog(info->dialog);
92 int nBindings = info->bindings.size();
93 for (int i = 0; i < nBindings; i++) {
94 info->bindings[i]->fire();
95 if (gui->getActiveDialog() == 0)
98 gui->setActiveDialog(0);
103 format_callback(puObject *obj, int dx, int dy, void *n)
105 SGPropertyNode *node = (SGPropertyNode *)n;
106 const char *format = node->getStringValue("format"), *f = format;
107 bool number, l = false;
108 // make sure the format matches '[ -+#]?\d*(\.\d*)?l?[fs]'
119 if (*f == ' ' || *f == '+' || *f == '-' || *f == '#')
121 while (*f && isdigit(*f))
125 while (*f && isdigit(*f))
133 else if (*f == 's') {
150 const char *src = obj->getLabel();
153 float value = atof(src);
154 snprintf(buf, 256, format, value);
156 snprintf(buf, 256, format, src);
161 SGPropertyNode *result = node->getNode("formatted", true);
162 result->setStringValue(buf);
163 obj->setLabel(result->getStringValue());
168 ////////////////////////////////////////////////////////////////////////
169 // Static helper functions.
170 ////////////////////////////////////////////////////////////////////////
173 * Copy a property value to a PUI object.
176 copy_to_pui (SGPropertyNode * node, puObject * object)
178 // Treat puText objects specially, so their "values" can be set
180 if(object->getType() & PUCLASS_TEXT) {
181 object->setLabel(node->getStringValue());
185 switch (node->getType()) {
186 case SGPropertyNode::BOOL:
187 case SGPropertyNode::INT:
188 case SGPropertyNode::LONG:
189 object->setValue(node->getIntValue());
191 case SGPropertyNode::FLOAT:
192 case SGPropertyNode::DOUBLE:
193 object->setValue(node->getFloatValue());
196 object->setValue(node->getStringValue());
203 copy_from_pui (puObject * object, SGPropertyNode * node)
205 // puText objects are immutable, so should not be copied out
206 if(object->getType() & PUCLASS_TEXT)
209 switch (node->getType()) {
210 case SGPropertyNode::BOOL:
211 case SGPropertyNode::INT:
212 case SGPropertyNode::LONG:
213 node->setIntValue(object->getIntegerValue());
215 case SGPropertyNode::FLOAT:
216 case SGPropertyNode::DOUBLE:
217 node->setFloatValue(object->getFloatValue());
220 // Special case to handle lists, as getStringValue cannot be overridden
221 if(object->getType() & PUCLASS_LIST)
223 node->setStringValue(((puList *) object)->getListStringValue());
227 node->setStringValue(object->getStringValue());
235 ////////////////////////////////////////////////////////////////////////
236 // Implementation of GUIInfo.
237 ////////////////////////////////////////////////////////////////////////
239 GUIInfo::GUIInfo (FGDialog * d)
246 for (unsigned int i = 0; i < bindings.size(); i++) {
254 ////////////////////////////////////////////////////////////////////////
255 // Implementation of FGDialog.
256 ////////////////////////////////////////////////////////////////////////
258 FGDialog::FGDialog (SGPropertyNode * props)
260 _gui((NewGUI *)globals->get_subsystem("gui"))
262 char* envp = ::getenv( "FG_FONTS" );
263 if ( envp != NULL ) {
264 _font_path.set( envp );
266 _font_path.set( globals->get_fg_root() );
267 _font_path.append( "Fonts" );
273 FGDialog::~FGDialog ()
275 puDeleteObject(_object);
279 // Delete all the arrays we made
280 // and were forced to keep around
281 // because PUI won't do its own
282 // memory management.
283 for (i = 0; i < _char_arrays.size(); i++) {
284 for (int j = 0; _char_arrays[i][j] != 0; j++)
285 free(_char_arrays[i][j]); // added with strdup
286 delete[] _char_arrays[i];
289 // Delete all the info objects we
290 // were forced to keep around because
291 // PUI cannot delete its own user data.
292 for (i = 0; i < _info.size(); i++) {
293 delete (GUIInfo *)_info[i];
297 // Finally, delete the property links.
298 for (i = 0; i < _propertyObjects.size(); i++) {
299 delete _propertyObjects[i];
300 _propertyObjects[i] = 0;
305 FGDialog::updateValue (const char * objectName)
307 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
308 const string &name = _propertyObjects[i]->name;
309 if (name == objectName)
310 copy_to_pui(_propertyObjects[i]->node,
311 _propertyObjects[i]->object);
316 FGDialog::applyValue (const char * objectName)
318 for (unsigned int i = 0; i < _propertyObjects.size(); i++) {
319 if (_propertyObjects[i]->name == objectName)
320 copy_from_pui(_propertyObjects[i]->object,
321 _propertyObjects[i]->node);
326 FGDialog::updateValues ()
328 for (unsigned int i = 0; i < _propertyObjects.size(); i++)
329 copy_to_pui(_propertyObjects[i]->node, _propertyObjects[i]->object);
333 FGDialog::applyValues ()
335 for (unsigned int i = 0; i < _propertyObjects.size(); i++)
336 copy_from_pui(_propertyObjects[i]->object,
337 _propertyObjects[i]->node);
343 for (unsigned int i = 0; i < _liveObjects.size(); i++) {
344 puObject *obj = _liveObjects[i]->object;
345 if (obj->getType() & PUCLASS_INPUT && ((puInput *)obj)->isAcceptingInput())
348 copy_to_pui(_liveObjects[i]->node, obj);
353 FGDialog::display (SGPropertyNode * props)
356 SG_LOG(SG_GENERAL, SG_ALERT, "This widget is already active");
360 int screenw = globals->get_props()->getIntValue("/sim/startup/xsize");
361 int screenh = globals->get_props()->getIntValue("/sim/startup/ysize");
363 bool userx = props->hasValue("x");
364 bool usery = props->hasValue("y");
365 bool userw = props->hasValue("width");
366 bool userh = props->hasValue("height");
368 // Let the layout widget work in the same property subtree.
369 LayoutWidget wid(props);
373 wid.calcPrefSize(&pw, &ph);
374 pw = props->getIntValue("width", pw);
375 ph = props->getIntValue("height", ph);
376 int px = props->getIntValue("x", (screenw - pw) / 2);
377 int py = props->getIntValue("y", (screenh - ph) / 2);
379 // Define "x", "y", "width" and/or "height" in the property tree if they
380 // are not specified in the configuration file.
381 wid.layout(px, py, pw, ph);
383 // Use the dimension and location properties as specified in the
384 // configuration file or from the layout widget.
385 _object = makeObject(props, screenw, screenh);
387 // Remove automatically generated properties, so the layout looks
388 // the same next time around.
389 if(!userx) props->removeChild("x");
390 if(!usery) props->removeChild("y");
391 if(!userw) props->removeChild("width");
392 if(!userh) props->removeChild("height");
397 SG_LOG(SG_GENERAL, SG_ALERT, "Widget "
398 << props->getStringValue("name", "[unnamed]")
399 << " does not contain a proper GUI definition");
404 FGDialog::makeObject (SGPropertyNode * props, int parentWidth, int parentHeight)
406 bool presetSize = props->hasValue("width") && props->hasValue("height");
407 int width = props->getIntValue("width", parentWidth);
408 int height = props->getIntValue("height", parentHeight);
409 int x = props->getIntValue("x", (parentWidth - width) / 2);
410 int y = props->getIntValue("y", (parentHeight - height) / 2);
411 string type = props->getName();
416 if (type == "dialog") {
418 bool draggable = props->getBoolValue("draggable", true);
419 if (props->getBoolValue("modal", false))
420 obj = new puDialogBox(x, y);
422 obj = new fgPopup(x, y, draggable);
423 setupGroup(obj, props, width, height, true);
424 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
427 } else if (type == "group") {
428 puGroup * obj = new puGroup(x, y);
429 setupGroup(obj, props, width, height, false);
430 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
433 } else if (type == "frame") {
434 puGroup * obj = new puGroup(x, y);
435 setupGroup(obj, props, width, height, true);
436 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
439 } else if (type == "hrule" || type == "vrule") {
440 puFrame * obj = new puFrame(x, y, x + width, y + height);
441 obj->setBorderThickness(0);
442 setColor(obj, props, FOREGROUND);
445 } else if (type == "list") {
446 puList * obj = new puList(x, y, x + width, y + height);
447 setupObject(obj, props);
448 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
451 } else if (type == "airport-list") {
452 AirportList * obj = new AirportList(x, y, x + width, y + height);
453 setupObject(obj, props);
454 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
457 } else if (type == "input") {
458 puInput * obj = new puInput(x, y, x + width, y + height);
459 setupObject(obj, props);
460 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
463 } else if (type == "text") {
464 puText * obj = new puText(x, y);
465 setupObject(obj, props);
467 if (props->getNode("format")) {
468 SGPropertyNode *live = props->getNode("live");
469 if (live && live->getBoolValue())
470 obj->setRenderCallback(format_callback, props);
472 format_callback(obj, x, y, props);
474 // Layed-out objects need their size set, and non-layout ones
475 // get a different placement.
476 if(presetSize) obj->setSize(width, height);
477 else obj->setLabelPlace(PUPLACE_LABEL_DEFAULT);
478 setColor(obj, props, LABEL);
481 } else if (type == "checkbox") {
483 obj = new puButton(x, y, x + width, y + height, PUBUTTON_XCHECK);
484 setupObject(obj, props);
485 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
488 } else if (type == "radio") {
490 obj = new puButton(x, y, x + width, y + height, PUBUTTON_CIRCLE);
491 setupObject(obj, props);
492 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
495 } else if (type == "button") {
497 const char * legend = props->getStringValue("legend", "[none]");
498 if (props->getBoolValue("one-shot", true))
499 obj = new puOneShot(x, y, legend);
501 obj = new puButton(x, y, legend);
503 obj->setSize(width, height);
504 setupObject(obj, props);
505 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
508 } else if (type == "combo") {
509 vector<SGPropertyNode_ptr> value_nodes = props->getChildren("value");
510 char ** entries = make_char_array(value_nodes.size());
511 for (unsigned int i = 0, j = value_nodes.size() - 1;
512 i < value_nodes.size();
514 entries[i] = strdup((char *)value_nodes[i]->getStringValue());
515 puComboBox * obj = new puComboBox(x, y, x + width, y + height, entries,
516 props->getBoolValue("editable", false));
517 setupObject(obj, props);
518 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
521 } else if (type == "slider") {
522 bool vertical = props->getBoolValue("vertical", false);
523 puSlider * obj = new puSlider(x, y, (vertical ? height : width));
524 obj->setMinValue(props->getFloatValue("min", 0.0));
525 obj->setMaxValue(props->getFloatValue("max", 1.0));
526 setupObject(obj, props);
528 obj->setSize(width, height);
529 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
532 } else if (type == "dial") {
533 puDial * obj = new puDial(x, y, width);
534 obj->setMinValue(props->getFloatValue("min", 0.0));
535 obj->setMaxValue(props->getFloatValue("max", 1.0));
536 obj->setWrap(props->getBoolValue("wrap", true));
537 setupObject(obj, props);
538 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
541 } else if (type == "textbox") {
542 int slider_width = props->getIntValue("slider", parentHeight);
543 int wrap = props->getBoolValue("wrap", true);
544 if (slider_width==0) slider_width=20;
545 puLargeInput * obj = new puLargeInput(x, y,
546 x+width, x+height, 2, slider_width, wrap);
548 if (props->hasValue("editable")) {
549 if (props->getBoolValue("editable")==false)
554 setupObject(obj, props);
555 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
558 } else if (type == "select") {
559 vector<SGPropertyNode_ptr> value_nodes;
560 SGPropertyNode * selection_node =
561 fgGetNode(props->getChild("selection")->getStringValue(), true);
563 for (int q = 0; q < selection_node->nChildren(); q++)
564 value_nodes.push_back(selection_node->getChild(q));
566 char ** entries = make_char_array(value_nodes.size());
567 for (unsigned int i = 0, j = value_nodes.size() - 1;
568 i < value_nodes.size();
570 entries[i] = strdup((char *)value_nodes[i]->getName());
572 new puSelectBox(x, y, x + width, y + height, entries);
573 setupObject(obj, props);
574 setColor(obj, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
582 FGDialog::setupObject (puObject * object, SGPropertyNode * props)
584 object->setLabelPlace(PUPLACE_CENTERED_RIGHT);
586 if (props->hasValue("legend"))
587 object->setLegend(props->getStringValue("legend"));
589 if (props->hasValue("label"))
590 object->setLabel(props->getStringValue("label"));
592 if (props->hasValue("border"))
593 object->setBorderThickness( props->getIntValue("border", 2) );
595 if ( SGPropertyNode *nft = props->getNode("font", false) ) {
596 SGPath path( _font_path );
597 const char *name = nft->getStringValue("name", "default");
598 float size = nft->getFloatValue("size", 13.0);
599 float slant = nft->getFloatValue("slant", 0.0);
601 path.concat( ".txf" );
603 fntFont *font = new fntTexFont;
604 font->load( (char *)path.c_str() );
606 puFont lfnt(font, size, slant);
607 object->setLabelFont( lfnt );
610 if (props->hasValue("property")) {
611 const char * name = props->getStringValue("name");
614 const char * propname = props->getStringValue("property");
615 SGPropertyNode_ptr node = fgGetNode(propname, true);
616 copy_to_pui(node, object);
617 PropertyObject* po = new PropertyObject(name, object, node);
618 _propertyObjects.push_back(po);
619 if(props->getBoolValue("live"))
620 _liveObjects.push_back(po);
623 SGPropertyNode * dest = fgGetNode("/sim/bindings/gui", true);
624 vector<SGPropertyNode_ptr> bindings = props->getChildren("binding");
625 if (bindings.size() > 0) {
626 GUIInfo * info = new GUIInfo(this);
628 for (unsigned int i = 0; i < bindings.size(); i++) {
630 SGPropertyNode *binding;
631 while (dest->getChild("binding", j))
634 binding = dest->getChild("binding", j, true);
635 copyProperties(bindings[i], binding);
636 info->bindings.push_back(new FGBinding(binding));
638 object->setCallback(action_callback);
639 object->setUserData(info);
640 _info.push_back(info);
643 object->makeReturnDefault(props->getBoolValue("default"));
647 FGDialog::setupGroup (puGroup * group, SGPropertyNode * props,
648 int width, int height, bool makeFrame)
650 setupObject(group, props);
653 puFrame* f = new puFrame(0, 0, width, height);
654 setColor(f, props, BACKGROUND|FOREGROUND|HIGHLIGHT);
657 int nChildren = props->nChildren();
658 for (int i = 0; i < nChildren; i++)
659 makeObject(props->getChild(i), width, height);
664 FGDialog::setColor(puObject * object, SGPropertyNode * props, int which)
666 string type = props->getName();
667 // first set whole color scheme (see below for a description)
668 FGColor c = _gui->getColor("background");
669 c.merge(_gui->getColor(type));
670 c.merge(props->getNode("color"));
671 object->setColourScheme(c.red(), c.green(), c.blue(), c.alpha());
673 // now look for the 6 plib color qualities
674 const int numcol = 6;
680 BACKGROUND, PUCOL_BACKGROUND, "background",
681 FOREGROUND, PUCOL_FOREGROUND, "foreground",
682 HIGHLIGHT, PUCOL_HIGHLIGHT, "highlight",
683 LABEL, PUCOL_LABEL, "label",
684 LEGEND, PUCOL_LEGEND, "legend",
685 MISC, PUCOL_MISC, "misc",
688 for (int i = 0; i < numcol; i++) {
689 // merge in object color quality components (e.g. "button-background")
690 FGColor c(_gui->getColor(type));
691 c.merge(_gui->getColor(type + '-' + pucol[i].name));
693 // merge in explicit color components from the XML structure (<color>)
694 if (which & pucol[i].mask)
695 c.merge(props->getNode("color"));
696 object->setColor(pucol[i].id, c.red(), c.green(), c.blue(), c.alpha());
702 FGDialog::make_char_array (int size)
704 char ** list = new char*[size+1];
705 for (int i = 0; i <= size; i++)
707 _char_arrays.push_back(list);
713 ////////////////////////////////////////////////////////////////////////
714 // Implementation of FGDialog::PropertyObject.
715 ////////////////////////////////////////////////////////////////////////
717 FGDialog::PropertyObject::PropertyObject (const char * n,
719 SGPropertyNode_ptr p)