new_gui.hxx

Go to the documentation of this file.

/*
 * SPDX-FileName: new_gui.hxx
 * SPDX-FileComment: XML-configured GUI subsystem.
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#pragma once
 
#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
#include <simgear/misc/sg_path.hxx>
 
#include <map>
#include <memory> // for unique_ptr on some systems
#include <cstring> // for strcmp in lstr() (in this header, alas)
 
class FGMenuBar;
class FGDialog;
class FGColor;

class NewGUI : public SGSubsystem
{
public:
    using FGDialogRef = SGSharedPtr<FGDialog>;

    NewGUI ();

    virtual ~NewGUI ();
 
    // Subsystem API.
    void bind() override;
    void init() override;
    void reinit() override;
    void shutdown() override;
    void unbind() override;
    void update(double delta_time_sec) override;
    void postinit() override;
 
    // Subsystem identification.
    static const char* staticSubsystemClassId() { return "gui"; }

    virtual void redraw ();

    virtual void newDialog (SGPropertyNode* node);

    virtual bool showDialog (const std::string &name);

    virtual bool toggleDialog (const std::string &name);
 

    virtual bool closeActiveDialog ();

    virtual bool closeDialog (const std::string &name);

    virtual SGPropertyNode_ptr getDialogProperties (const std::string &name);

    virtual FGMenuBar * getMenuBar ();

    virtual void setActiveDialog (FGDialog * dialog);

    virtual FGDialogRef getActiveDialog();
 

    virtual FGDialogRef getDialog(const std::string& name);
 
 
    virtual FGColor *getColor (const char * name) const {
        _citt_t it = _colors.find(name);
        return (it != _colors.end()) ? it->second : NULL;
    }
    virtual FGColor *getColor (const std::string &name) const {
        _citt_t it = _colors.find(name.c_str());
        return (it != _colors.end()) ? it->second : NULL;
    }
 
protected:
    virtual bool getMenuBarVisible () const;

    virtual void setMenuBarVisible (bool visible);
 
    virtual void setStyle ();

    virtual void reset (bool reload);
 
    bool getMenuBarOverlapHide() const;
    void setMenuBarOverlapHide(bool hide);
 
private:
    void createMenuBarImplementation();
    // Assign an element of _dialog_metadata.
    void setDialogMetadata(const std::string& name, const SGPath& xmlFilepath,
                           const std::string& translationDomain = "core");
 
    typedef std::map<std::string, FGColor*> ColourDict;
    ColourDict _colors;
    typedef ColourDict::iterator _itt_t;
    typedef ColourDict::const_iterator _citt_t;
    void clear_colors();
 
    // Read all the configuration files in a directory. The translation domain
    // may be overridden from each dialog XML definition.
    void readDir(const SGPath& path, const std::string& translationDomain);
 
    std::unique_ptr<FGMenuBar> _menubar;
    FGDialogRef _active_dialog;
 
 
    typedef std::map<std::string, FGDialogRef> DialogDict;
    DialogDict _active_dialogs;
 
    struct DialogMetadata {
        DialogMetadata(const SGPath& xmlFilePath,
                       const std::string& translationDomain);
 
        SGPath xmlFilePath;            
        std::string translationDomain; 
    };
 
    typedef std::map<std::string, DialogMetadata> DialogMetadataDict;
    // For each dialog name, this gives a path to the XML PropertyList file
    // that defines the dialog contents and the domain used for fetching
    // translations of text elements of the dialog (labels, etc.).
    DialogMetadataDict _dialog_metadata;
 
    // cache of loaded dialog proeprties
    typedef std::map<std::string,SGPropertyNode_ptr> NameDialogDict;
    NameDialogDict _dialog_props;
};