GNEOptionsDialog.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
/****************************************************************************/
// A Dialog for setting options (see OptionsCont)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <set>
#include <utils/gui/images/GUIIcons.h>
#include <utils/foxtools/MFXCheckableButton.h>
#include <utils/foxtools/MFXCheckButtonTooltip.h>
#include <utils/foxtools/MFXDialogBox.h>
#include <utils/foxtools/MFXTextFieldSearch.h>
 
#include "GNEOptionsDialogElements.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEApplicationWindow;
class OptionsCont;
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEOptionsDialog : public MFXDialogBox {
    FXDECLARE(GNEOptionsDialog)
 
    
    friend class GNEOptionsDialogElements;
 
public:
    static std::pair<int, bool> Options(GNEApplicationWindow* GNEApp, GUIIcon icon, OptionsCont& optionsContainer,
                                        const OptionsCont& originalOptionsContainer, const char* titleName);
 
    static std::pair<int, bool> Run(GNEApplicationWindow* GNEApp, GUIIcon icon, OptionsCont& optionsContainer,
                                    const OptionsCont& originalOptionsContainer, const char* titleName);
 
    ~GNEOptionsDialog();
 
    void runInternalTest(const InternalTestStep::DialogTest* modalArguments);
 
 
    long onCmdCancel(FXObject*, FXSelector, void*);
 
    long onCmdReset(FXObject*, FXSelector, void*);
 
    long onCmdRunNetgenerate(FXObject*, FXSelector, void*);
 
    long onCmdSelectTopic(FXObject*, FXSelector, void*);
 
    long onCmdSearch(FXObject*, FXSelector, void*);
 
    long onCmdShowToolTipsMenu(FXObject*, FXSelector, void*);
 
    long onCmdSaveOptions(FXObject*, FXSelector, void*);
 
    long onCmdLoadOptions(FXObject*, FXSelector, void*);
 
    long onCmdResetDefault(FXObject*, FXSelector, void*);
 
 
protected:
    GNEOptionsDialog();
 
    GNEApplicationWindow* myGNEApp;
 
    OptionsCont& myOptionsContainer;
 
    const OptionsCont& myOriginalOptionsContainer;
 
    bool myOptionsModified = false;
 
private:
    MFXCheckableButton* myShowToolTipsMenu = nullptr;
 
    FXTreeList* myTopicsTreeList = nullptr;
 
    FXTreeItem* myRootItem = nullptr;
 
    FXVerticalFrame* myEntriesFrame = nullptr;
 
    MFXCheckButtonTooltip* myDescriptionSearchCheckButton = nullptr;
 
    MFXTextFieldSearch* mySearchButton = nullptr;
 
    std::map<FXTreeItem*, std::string> myTreeItemTopics;
 
    std::vector<GNEOptionsDialogElements::InputOption*> myInputOptionEntries;
 
    const std::set<std::string> myIgnoredTopics = {"Configuration"};
 
    const std::set<std::string> myIgnoredEntries = {"geometry.remove", "edges.join", "geometry.split", "ramps.guess", "ramps.set"};
 
    bool updateVisibleEntriesByTopic();
 
    void updateVisibleEntriesBySearch(std::string searchText);
 
    bool loadConfiguration(const std::string& file);
 
    GNEOptionsDialog(GNEApplicationWindow* GNEApp, GUIIcon icon, OptionsCont& optionsContainer,
                     const OptionsCont& originalOptionsContainer, const char* titleName, const bool runDialog);
 
    GNEOptionsDialog(const GNEOptionsDialog&) = delete;
 
    GNEOptionsDialog& operator=(const GNEOptionsDialog&) = delete;
};