GNEDialog.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2006-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
/****************************************************************************/
// Custom FXDialogBox used in Netedit that supports internal tests
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <utils/gui/images/GUIIcons.h>
#include <utils/tests/InternalTestStep.h>
 
#include "GNEDialogEnum.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEApplicationWindow;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDialog : protected FXDialogBox {
    FXDECLARE_ABSTRACT(GNEDialog)
 
public:
    enum class Buttons {
        OK,                     // ok button
        YES_NO,                 // yes/no buttons
        YES_NO_CANCEL,          // yes/no/cancel buttons
        ACCEPT,                 // accept button
        ACCEPT_CANCEL,          // accept/cancel buttons
        ACCEPT_CANCEL_RESET,    // accept/cancel/reset buttons
        SAVE_DONTSAVE_CANCEL,   // save/don't save/cancel buttons
        RUN_CANCEL_RESET,       // run/cancel/reset buttons (used in tools dialogs)
        RUN_ADVANCED_CANCEL,    // run/advanced/cancel buttons (used in tools dialogs)
        RERUN_BACK_OK,          // rerun-abort/back buttons (used in run dialogs)
        OK_COPY_REPORT          // ok, copy trace and report to github
    };
 
    enum class OpenType {
        MODAL,      // Modal dialog
        NON_MODAL   // Non-modal dialog
    };
 
    enum class ResizeMode {
        STATIC,     // dialog is static (size cannot be edited)
        RESIZABLE   // dialog is resizable (in both directions)
    };
 
    enum class Result {
        ACCEPT,     // dialog was closed accepting changes (used in ok, accept, yes buttons)
        CANCEL,     // dialog was closed canceling changes (used in cancel, no buttons)
        ABORT,      // dialog was closed aborting changes (used in abort button)
        ACCEPT_ALL, // dialog was closed acepting all changes (used in ok, accept, yes buttons)
        CANCEL_ALL, // dialog was closed canceling all changes (used in cancel, no buttons)
    };
 
    GNEDialog(GNEApplicationWindow* applicationWindow,
              const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
              OpenType openType, ResizeMode resizeMode);
 
    GNEDialog(GNEApplicationWindow* applicationWindow, GNEDialog* parentDialog,
              const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
              OpenType openType, ResizeMode resizeMode);
 
    GNEDialog(GNEApplicationWindow* applicationWindow,
              const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
              OpenType openType, ResizeMode resizeMode, const int width, const int height);
 
    GNEDialog(GNEApplicationWindow* applicationWindow, GNEDialog* parentDialog,
              const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
              OpenType openType, ResizeMode resizeMode, const int width, const int height);
 
    Result getResult() const;
 
    GNEApplicationWindow* getApplicationWindow() const;
 
    FXVerticalFrame* getContentFrame() const;
 
    virtual void runInternalTest(const InternalTestStep::DialogArgument* dialogArgument) = 0;
 
 
    virtual long onCmdAccept(FXObject*, FXSelector, void*);
 
    virtual long onCmdCancel(FXObject*, FXSelector, void*);
 
    virtual long onCmdAbort(FXObject*, FXSelector, void*);
 
    virtual long onCmdReset(FXObject*, FXSelector, void*);
 
    virtual long onCmdRun(FXObject*, FXSelector, void*);
 
    virtual long onCmdBack(FXObject*, FXSelector, void*);
 
    virtual long onCmdAdvanced(FXObject*, FXSelector, void*);
 
    virtual long onCmdCopy(FXObject*, FXSelector, void*);
 
    virtual long onCmdReport(FXObject*, FXSelector, void*);
 
    long onKeyPress(FXObject* obj, FXSelector sel, void* ptr);
 
    long onKeyRelease(FXObject* obj, FXSelector sel, void* ptr);
 
 
protected:
    FOX_CONSTRUCTOR(GNEDialog)
 
    
    GNEApplicationWindow* myApplicationWindow = nullptr;
 
    GNEDialog* myParentDialog = nullptr;
 
    FXVerticalFrame* myContentFrame = nullptr;
 
    FXButton* myAcceptButton = nullptr;
 
    FXButton* myCancelButton = nullptr;
 
    FXButton* myAbortButton = nullptr;
 
    FXButton* myResetButton = nullptr;
 
    FXButton* myRunButton = nullptr;
 
    FXButton* myBackButton = nullptr;
 
    FXButton* myAdvancedButton = nullptr;
 
    FXButton* myCopyButton = nullptr;
 
    FXButton* myReportButton = nullptr;
 
    DialogType myType = DialogType::DEFAULT;
 
    Result myResult = Result::CANCEL;
 
    void openDialog(FXWindow* focusableElement = nullptr);
 
    long closeDialogAccepting();
 
    long closeDialogCanceling();
 
    long closeDialogAborting();
 
    void updateTitle(const std::string& newTitle);
 
    void updateIcon(GUIIcon newIcon);
 
private:
    FXButton* myFocusButton = nullptr;
 
    OpenType myOpenType;
 
    bool myTesting = false;
 
    void buildDialog(GUIIcon titleIcon, Buttons buttons);
 
    GNEDialog(const GNEDialog&) = delete;
 
    GNEDialog& operator=(const GNEDialog& src) = delete;
};