PUICompatObject.hxx

Go to the documentation of this file.

// PUICompatDialog.hxx - XML dialog object without using PUI
// Copyright (C) 2022 James Turner
// SPDX-License-Identifier: GPL-2.0-or-later
 
#pragma once
 
#include <simgear/math/SGMath.hxx>
#include <simgear/nasal/cppbind/NasalHash.hxx>
#include <simgear/nasal/cppbind/NasalObject.hxx>
#include <simgear/props/propsfwd.hxx>
#include <simgear/structure/SGBinding.hxx>
#include <simgear/structure/SGReferenced.hxx>
 
class PUICompatObject;
class FGPUICompatDialog;
 
using PUICompatObjectRef = SGSharedPtr<PUICompatObject>;
using PUICompatObjectVec = std::vector<PUICompatObjectRef>;
 
using PUICompatDialogRef = SGSharedPtr<FGPUICompatDialog>;
 
class PUICompatObject : public nasal::Object, public SGPropertyChangeListener
{
public:
    static PUICompatObjectRef createForType(const std::string& type, SGPropertyNode_ptr config);
 
    static void setupGhost(nasal::Hash& guiModule);
 
    virtual ~PUICompatObject();
 
    virtual void init();
 
    virtual void update();
 
    virtual void apply();
 
    virtual void updateValue();
 
    naRef config() const;
    
    naRef property() const;
    
    naRef propertyValue(naContext ctx) const;
 
    PUICompatObjectRef parent() const;
 
    PUICompatDialogRef dialog() const;
 
    PUICompatObjectVec children() const;
 
    naRef show(naRef viewParent);
 
    double getX() const;
    double getY() const;
    double width() const;
    double height() const;
 
    SGRectd geometry() const;
 
    // bool heightForWidth properties
 
    void setGeometry(const SGRectd& g);
 
    bool visible() const;
    bool enabled() const;
    const std::string& type() const;
 
    const std::string& name() const
    {
        return _name;
    }
 
    void setVisible(bool v);
    void setEnabled(bool e);

    PUICompatObjectRef widgetByName(const std::string& name) const;
 

    std::string radioGroupIdent() const;
 
    bool isLive() const
    {
        return _live != LiveValueMode::OnApply;
    }
 
    bool hasBindings() const;
 
    std::string translatePluralString(const std::string& key, int cardinal,
                                      const std::string& resource = {},
                                      const std::string& domain = {}) const;
    std::string translateString(const std::string& key,
                                const std::string& resource = {},
                                const std::string& domain = {}) const;
protected:
    PUICompatObject(naRef impl, const std::string& type);
 
    virtual void activateBindings();
 
    virtual void updateGeometry(const SGRectd& newGeom);
 
    void valueChanged(SGPropertyNode* node) override;
 
    // emporary solution to decide which SGPropertyNode children of an
    // object, are children
    static bool isNodeAChildObject(const std::string& nm, int uiVersion);
 
private:
    enum class LiveValueMode {
        OnApply,  
        Listener, 
        Polled    
    };
 
    friend class FGPUICompatDialog;
 
    friend naRef f_makeCompatObjectPeer(const nasal::CallContext& ctx);
 
    naRef nasalGetConfigValue(const nasal::CallContext ctx) const;
 
    void setDialog(PUICompatDialogRef dialog);
 
    void recursiveUpdate(const std::string& objectName = {});
    void recursiveUpdateValues(const std::string& objectName = {});
    void recursiveApply(const std::string& objectName = {});
    void recursiveOnDelete();
 
    void doActivate();
    
    nasal::Hash gridLocation(const nasal::CallContext& ctx) const;
 
    SGWeakPtr<PUICompatObject> _parent;
    SGWeakPtr<FGPUICompatDialog> _dialog;
 
    PUICompatObjectVec _children; // owning references to children
 
    SGPropertyNode_ptr _config;
 
    std::string _type;
    std::string _label;
    std::string _name;
    std::string _oldPolledValue;
 
    SGPropertyNode_ptr _value;
    SGRectd _geometry;
 
    LiveValueMode _live = LiveValueMode::OnApply;
    bool _valueChanged = false;
    bool _visible = true;
    bool _enabled = true;
    bool _labelChanged = false;
 
    SGConditionRef _visibleCondition;
    SGConditionRef _enableCondition;
 
    SGBindingList _bindings;
};