GNEPythonToolDialog.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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
/****************************************************************************/
// Dialog for tools
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/foxtools/MFXDialogBox.h>
#include <utils/options/OptionsCont.h>
 
#include "GNEPythonToolDialogElements.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEApplicationWindow;
class GNEPythonTool;
class MFXCheckableButton;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEPythonToolDialog : protected MFXDialogBox {
    FXDECLARE(GNEPythonToolDialog)
 
    
    friend class GNEPythonToolDialogElements;
 
public:
    GNEPythonToolDialog(GNEApplicationWindow* GNEApp);
 
    ~GNEPythonToolDialog();
 
    void openDialog(GNEPythonTool* tool);
 
    void runInternalTest(const InternalTestStep::DialogTest* modalArguments);
 
    GNEApplicationWindow* getGNEApplicationWindow() const;
 
    const GNEPythonTool* getPythonTool() const;
 
 
    long onCmdShowToolTipsMenu(FXObject*, FXSelector, void*);
 
    long onCmdSave(FXObject*, FXSelector, void*);
 
    long onCmdLoad(FXObject*, FXSelector, void*);
 
    long onCmdSetVisualization(FXObject*, FXSelector, void*);
 
    long onCmdRun(FXObject*, FXSelector, void*);
 
    long onCmdCancel(FXObject*, FXSelector, void*);
 
    long onCmdReset(FXObject*, FXSelector, void*);
 
    long onUpdRequiredAttributes(FXObject* sender, FXSelector, void*);
 
 
protected:
    class CategoryOptions : public std::string {
 
    public:
        CategoryOptions(const std::string& category);
 
        void addOption(const std::string& name, Option* option);
 
        const std::vector<std::pair<std::string, Option*> >& getOptions() const;
 
        void sortByName();
 
    private:
        std::vector<std::pair<std::string, Option*> > myOptions;
 
        CategoryOptions() {}
    };
 
    GNEPythonToolDialog();
 
    void buildArguments(bool sortByName, bool groupedByCategories);
 
    void adjustParameterColumn();
 
    OptionsCont myCustomToolsOptions;
 
    std::vector<GNEPythonToolDialog::CategoryOptions> getOptions(OptionsCont& optionsCont) const;
 
    std::vector<CategoryOptions> getOptionsByCategories(OptionsCont& optionsCont) const;
 
    int getNumRowColums() const;
 
    FXVerticalFrame* getArgumentFrameLeft() const;
 
    FXVerticalFrame* getArgumentFrameRight() const;
 
    std::vector<GNEPythonToolDialogElements::Argument*> myArguments;
 
    std::vector<GNEPythonToolDialogElements::Category*> myCategories;
 
private:
    GNEApplicationWindow* myGNEApp;
 
    MFXCheckableButton* myShowToolTipsMenu = nullptr;
 
    FXCheckButton* mySortedCheckButton = nullptr;
 
    FXCheckButton* myGroupedCheckButton = nullptr;
 
    FXVerticalFrame* myArgumentFrameLeft = nullptr;
 
    FXVerticalFrame* myArgumentFrameRight = nullptr;
 
    GNEPythonTool* myPythonTool = nullptr;
 
    GNEPythonToolDialog(const GNEPythonToolDialog&) = delete;
 
    GNEPythonToolDialog& operator=(const GNEPythonToolDialog&) = delete;
};