flightgear/src/GUI/FGPUIDialog.hxx

// FGPUIDialog.hxx - XML-configured dialog box.

#pragma once

#include "dialog.hxx"

#include <plib/puAux.h>

#include <simgear/misc/sg_path.hxx>
#include <simgear/props/condition.hxx>
#include <simgear/props/props.hxx>

#include <vector>


// 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
#define FGCLASS_WAYPOINTLIST 0x00000008
#define FGCLASS_LOGLIST 0x00000010

class GUI_ID
{
public:
    GUI_ID(int id) : id(id) {}
    virtual ~GUI_ID() {}
    int id;
};

class NewGUI;
class FGColor;
class puObject;
class puFont;

/**
 * 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 FGPUIDialog : public 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.
     */
    FGPUIDialog(SGPropertyNode* props);


    /**
     * Destructor.
     */
    virtual ~FGPUIDialog();


    /**
     * Update the values of all GUI objects with a specific name,
     * or all if an empty name is given (default).
     *
     * 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 objects.
     */
    virtual void updateValues(const std::string& objectName = "");


    /**
     * Apply the values of all GUI objects with a specific name,
     * or all if an empty name is given (default).
     *
     * 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 objects.
     */
    virtual void applyValues(const std::string& objectName = "");


    /**
     * Update state.  Called on active dialogs before rendering.
     */
    virtual void update();

    /**
     * Recompute the dialog's layout
     */
    void relayout();


    void setNeedsLayout()
    {
        _needsRelayout = true;
    }
    virtual const char* getName();
    virtual void bringToFront();

    class ActiveWidget
    {
    public:
        virtual void update() = 0;
    };

private:
    enum {
        BACKGROUND = 0x01,
        FOREGROUND = 0x02,
        HIGHLIGHT = 0x04,
        LABEL = 0x08,
        LEGEND = 0x10,
        MISC = 0x20,
        EDITFIELD = 0x40
    };

    // 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);

    /**
     * Apply layout sizes to a tree of puObjects
     */
    void applySize(puObject* object);

    // The top-level PUI object.
    puObject* _object;

    // 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.
    std::string _module;
    SGPropertyNode_ptr _nasal_close;

    std::string _name;
    // 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.
    std::vector<void*> _info;
    struct PropertyObject {
        PropertyObject(const char* name,
                       puObject* object,
                       SGPropertyNode_ptr node);
        std::string name;
        puObject* object;
        SGPropertyNode_ptr node;
    };
    std::vector<PropertyObject*> _propertyObjects;
    std::vector<PropertyObject*> _liveObjects;

    class ConditionalObject : public SGConditional
    {
    public:
        ConditionalObject(const std::string& aName, puObject* aPu) : _name(aName),
                                                                     _pu(aPu)
        {
            ;
        }

        void update(FGPUIDialog* aDlg);

    private:
        const std::string _name;
        puObject* _pu;
    };

    typedef SGSharedPtr<ConditionalObject> ConditionalObjectRef;
    std::vector<ConditionalObjectRef> _conditionalObjects;

    std::vector<ActiveWidget*> _activeWidgets;
};