FGPUICompatDialog.hxx

Go to the documentation of this file.

// SPDX-FileName: FGPUICompatDialog.hxx
// SPDX-FileComment: XML dialog class without using PUI
// SPDX-FileCopyrightText: Copyright (C) 2022 James Turner
// SPDX-License-Identifier: GPL-2.0-or-later
 
#pragma once
 
#include <cstdint>
 
#include "dialog.hxx"
#include "simgear/math/SGRect.hxx"
 
 
#include <simgear/misc/sg_path.hxx>
#include <simgear/nasal/cppbind/NasalHash.hxx>
#include <simgear/nasal/cppbind/NasalObject.hxx>
#include <simgear/props/condition.hxx>
#include <simgear/props/props.hxx>
 
 
class NewGUI;
class FGColor;
 
class PUICompatObject;
using PUICompatObjectRef = SGSharedPtr<PUICompatObject>;

class FGPUICompatDialog : public FGDialog
{
public:
    static void setupGhost(nasal::Hash& compatModule);

    FGPUICompatDialog(SGPropertyNode* props,
                      std::string translationDomain = "core");
 

    virtual ~FGPUICompatDialog();
 

    virtual void updateValues(const std::string& objectName = "");
 

    virtual void applyValues(const std::string& objectName = "");
 
    bool init();

    void update() override;

    void relayout();
 
 
    void setNeedsLayout()
    {
        _needsRelayout = true;
    }
 
    virtual const char* getName();
    virtual void bringToFront();
 
    std::string nameString() const;
    std::string nasalModule() const;
 
    SGRectd geometry() const;
 
    double getX() const;
    double getY() const;
    double width() const;
    double height() const;
 
    void close() override;
 
    std::string title() const;
    void setTitle(const std::string& s);
 
    const std::string& windowType() const
    {
        return _windowType;
    }

    uint32_t uiVersion() const
    {
        return _uiVersion;
    }

    PUICompatObjectRef widgetByName(const std::string& name) const;
 
    void runCallback(const std::string& name, SGPropertyNode_ptr args) override;
 
private:
    friend naRef f_makeDialogPeer(const nasal::CallContext& ctx);
    friend naRef f_dialogRootObject(FGPUICompatDialog& dialog, naContext c);
 
    // Show the dialog.
    void display(SGPropertyNode* props);
 
    void requestClose();
 
    // return key code number for keystring
    int getKeyCode(const char* keystring);
 
    // The source xml tree, so that we can pass data back, such as the
    // last position.
    SGPropertyNode_ptr _props;
 
    bool _needsRelayout;
    SGRectd _geometry = SGRectd{0.0, 0.0, 0.0, 0.0};
 
    // Nasal module.
    std::string _module;
    SGPropertyNode_ptr _nasal_close;
 
    class DialogPeer;
 
    SGSharedPtr<DialogPeer> _peer;
 
    std::string _windowType; 
    std::string _name;
    PUICompatObjectRef _root;
    std::string _title;
    uint32_t _uiVersion = 0;
};