GNEOptionsEditorRow.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Row used in GNEOptionsEditor to edit options
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <utils/foxtools/fxheader.h>
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEOptionsEditor;
class MFXLabelTooltip;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEOptionsEditorRow {
 
public:

    class OptionRow : public FXHorizontalFrame {
        FXDECLARE_ABSTRACT(GNEOptionsEditorRow::OptionRow)
 
    public:
        OptionRow(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                  const std::string& name, const std::string& description, const std::string& defaultValue,
                  const bool editable, const bool requireSaveNetwork);

        void adjustNameSize();

        const std::string& getTopic() const;

        const std::string getNameLower() const;

        const std::string getDescriptionLower() const;

        bool isEditable() const;

        virtual void updateOption() = 0;

        virtual void restoreOption() = 0;

        virtual long onCmdSetOption(FXObject*, FXSelector, void*) = 0;

        virtual long onCmdResetOption(FXObject*, FXSelector, void*) = 0;
 
    protected:
        FOX_CONSTRUCTOR(OptionRow)
 
        
        GNEOptionsEditor* myOptionsEditor = nullptr;

        const std::string myTopic;

        const std::string myName;

        const std::string myDescription;

        const std::string myDefaultValue;

        FXHorizontalFrame* myContentFrame = nullptr;

        const bool myEditable = true;

        const bool myRequireSaveNetwork = false;

        void updateResetButton();
 
    private:
        virtual std::string getValue() const = 0;

        MFXLabelTooltip* myNameLabel = nullptr;
 
        // @brief reset button
        FXButton* myResetButton = nullptr;
    };

    class OptionString : public OptionRow {
 
    public:
        OptionString(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                     const std::string& name, const std::string& description, const std::string& defaultValue,
                     const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        FXTextField* myStringTextField = nullptr;
    };

    class OptionStringVector : public OptionRow {
 
    public:
        OptionStringVector(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                           const std::string& name, const std::string& description, const std::string& defaultValue,
                           const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        FXTextField* myStringVectorTextField = nullptr;
    };

    class OptionBool : public OptionRow {
 
    public:
        OptionBool(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                   const std::string& name, const std::string& description, const std::string& defaultValue,
                   const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        FXCheckButton* myCheckButton = nullptr;
    };

    class OptionInt : public OptionRow {
 
    public:
        OptionInt(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                  const std::string& name, const std::string& description, const std::string& defaultValue,
                  const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        FXTextField* myIntTextField = nullptr;
    };

    class OptionIntVector : public OptionRow {
 
    public:
        OptionIntVector(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                        const std::string& name, const std::string& description, const std::string& defaultValue,
                        const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        FXTextField* myIntVectorTextField = nullptr;
    };

    class OptionFloat : public OptionRow {
 
    public:
        OptionFloat(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                    const std::string& name, const std::string& description, const std::string& defaultValue,
                    const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        std::string parseFloat(const std::string& value) const;

        FXTextField* myFloatTextField = nullptr;
    };

    class OptionTime : public OptionRow {
 
    public:
        OptionTime(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                   const std::string& name, const std::string& description, const std::string& defaultValue,
                   const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    private:
        std::string getValue() const;

        std::string parseTime(const std::string& value) const;

        FXTextField* myTimeTextField = nullptr;
    };

    class OptionFilename : public OptionRow {
        FXDECLARE(GNEOptionsEditorRow::OptionFilename)
 
    public:
        OptionFilename(GNEOptionsEditor* optionsEditor, FXComposite* parent, const std::string& topic,
                       const std::string& name, const std::string& description, const std::string& defaultValue,
                       const bool editable, const bool requireSaveNetwork);

        void updateOption();

        void restoreOption();

        long onCmdOpenDialog(FXObject*, FXSelector, void*);

        long onCmdSetOption(FXObject*, FXSelector, void*);

        long onCmdResetOption(FXObject*, FXSelector, void*);
 
    protected:
        OptionFilename();
 
    private:
        std::string getValue() const;

        FXButton* myOpenFilenameButton = nullptr;

        FXTextField* myFilenameTextField = nullptr;
    };
};