GNEDialog.cpp

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
/****************************************************************************/
 
#include <fxkeys.h>
#include <netedit/GNEApplicationWindow.h>
#include <netedit/GNEInternalTest.h>
#include <utils/gui/div/GUIDesigns.h>
 
#include "GNEDialog.h"
 
// ===========================================================================
// FOX callback mapping
// ===========================================================================
 
FXDEFMAP(GNEDialog) MFXDialogBoxMap[] = {
    // interaction
    FXMAPFUNC(SEL_KEYPRESS,     0,  GNEDialog::onKeyPress),
    FXMAPFUNC(SEL_KEYRELEASE,   0,  GNEDialog::onKeyRelease),
    // buttons
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_ACCEPT,      GNEDialog::onCmdAccept),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_CANCEL,      GNEDialog::onCmdCancel),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_RESET,       GNEDialog::onCmdReset),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_RUN,         GNEDialog::onCmdRun),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_BACK,        GNEDialog::onCmdBack),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_ADVANCED,    GNEDialog::onCmdAdvanced),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_COPY,        GNEDialog::onCmdCopy),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_BUTTON_REPORT,      GNEDialog::onCmdReport),
    // abort dialog
    FXMAPFUNC(SEL_CLOSE,    0,              GNEDialog::onCmdAbort),
    FXMAPFUNC(SEL_COMMAND,  MID_HOTKEY_ESC, GNEDialog::onCmdAbort),
    FXMAPFUNC(SEL_CHORE,    MID_GNE_ABORT,  GNEDialog::onCmdAbort),
    FXMAPFUNC(SEL_TIMEOUT,  MID_GNE_ABORT,  GNEDialog::onCmdAbort),
    FXMAPFUNC(SEL_COMMAND,  MID_GNE_ABORT,  GNEDialog::onCmdAbort),
};
 
// Object implementation
FXIMPLEMENT_ABSTRACT(GNEDialog, FXDialogBox, MFXDialogBoxMap, ARRAYNUMBER(MFXDialogBoxMap))
 
// ===========================================================================
// method definitions
// ===========================================================================
 
GNEDialog::GNEDialog(GNEApplicationWindow* applicationWindow,
                     const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
                     OpenType openType, ResizeMode resizeMode) :
    FXDialogBox(applicationWindow->getApp(), name.c_str(),
                (resizeMode == ResizeMode::STATIC) ? GUIDesignGNEDialogStatic : GUIDesignGNEDialogResizable,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
    myApplicationWindow(applicationWindow),
    myType(type),
    myOpenType(openType) {
    // build dialog only if applicationWindow was created
    if (applicationWindow->id()) {
        buildDialog(titleIcon, buttons);
    }
}
 
 
GNEDialog::GNEDialog(GNEApplicationWindow* applicationWindow, GNEDialog* parentDialog,
                     const std::string& name, GUIIcon titleIcon, DialogType type, Buttons buttons,
                     OpenType openType, ResizeMode resizeMode) :
    FXDialogBox(applicationWindow->getApp(), name.c_str(),
                (resizeMode == ResizeMode::STATIC) ? GUIDesignGNEDialogStatic : GUIDesignGNEDialogResizable,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
    myApplicationWindow(applicationWindow),
    myParentDialog(parentDialog),
    myType(type),
    myOpenType(openType) {
    // build dialog only if applicationWindow was created
    if (applicationWindow->id()) {
        buildDialog(titleIcon, buttons);
    }
}
 
 
GNEDialog::GNEDialog(GNEApplicationWindow* applicationWindow, const std::string& name,
                     GUIIcon titleIcon, DialogType type, Buttons buttons, OpenType openType,
                     ResizeMode resizeMode, const int width, const int height) :
    FXDialogBox(applicationWindow->getApp(), name.c_str(),
                (resizeMode == ResizeMode::STATIC) ? GUIDesignGNEDialogStaticExplicit : GUIDesignGNEDialogResizableExplicit,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
    myApplicationWindow(applicationWindow),
    myType(type),
    myOpenType(openType) {
    // build dialog only if applicationWindow was created
    if (applicationWindow->id()) {
        // build dialog
        buildDialog(titleIcon, buttons);
        // set explicit size
        resize(width, height);
    }
}
 
 
GNEDialog::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) :
    FXDialogBox(applicationWindow->getApp(), name.c_str(),
                (resizeMode == ResizeMode::STATIC) ? GUIDesignGNEDialogStaticExplicit : GUIDesignGNEDialogResizableExplicit,
                0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
    myApplicationWindow(applicationWindow),
    myParentDialog(parentDialog),
    myType(type),
    myOpenType(openType) {
    // build dialog only if applicationWindow was created
    if (applicationWindow->id()) {
        // build dialog
        buildDialog(titleIcon, buttons);
        // set explicit size
        resize(width, height);
    }
}
 
 
GNEDialog::Result
GNEDialog::getResult() const {
    return myResult;
}
 
 
GNEApplicationWindow*
GNEDialog::getApplicationWindow() const {
    return myApplicationWindow;
}
 
 
FXVerticalFrame*
GNEDialog::getContentFrame() const {
    return myContentFrame;
}
 
 
long
GNEDialog::onCmdAccept(FXObject*, FXSelector, void*) {
    return closeDialogAccepting();
}
 
 
long
GNEDialog::onCmdCancel(FXObject*, FXSelector, void*) {
    return closeDialogCanceling();
}
 
 
long
GNEDialog::onCmdAbort(FXObject*, FXSelector, void*) {
    return closeDialogAborting();
}
 
 
long
GNEDialog::onCmdReset(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdReset function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onCmdRun(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdRun function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onCmdBack(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdBack function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onCmdAdvanced(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdAdvanced function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onCmdCopy(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdyCopy function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onCmdReport(FXObject*, FXSelector, void*) {
    throw ProcessError("onCmdyReport function must be reimplemented in GNEDialog children");
}
 
 
long
GNEDialog::onKeyPress(FXObject* obj, FXSelector sel, void* ptr) {
    if (myTesting && (obj != myApplicationWindow->getInternalTest())) {
        return 1;
    } else {
        // if ESC key is pressed, close dialog aborting
        FXEvent* event = (FXEvent*)ptr;
        if (event->code == KEY_Escape) {
            return closeDialogAborting();
        } else if (event->code == KEY_Return) {
            if (myAcceptButton->hasFocus()) {
                return closeDialogAccepting();
            } else if (myCancelButton->hasFocus()) {
                return closeDialogCanceling();
            } else if (myAbortButton && myAbortButton->hasFocus()) {
                return closeDialogAborting();
            }
        }
        return FXDialogBox::onKeyPress(obj, sel, ptr);
    }
}
 
 
long
GNEDialog::onKeyRelease(FXObject* obj, FXSelector sel, void* ptr) {
    if (myTesting && (obj != myApplicationWindow->getInternalTest())) {
        return 1;
    } else {
        return FXDialogBox::onKeyRelease(obj, sel, ptr);
    }
}
 
 
void
GNEDialog::openDialog(FXWindow* focusableElement) {
    // create dialog
    create();
    // check if set focus in button
    if (focusableElement) {
        focusableElement->setFocus();
    } else {
        myFocusButton->setFocus();
    }
    // show in the center of app
    show(PLACEMENT_OWNER);
    // continue depending on whether we are testing or not
    const auto internalTest = myApplicationWindow->getInternalTest();
    if (internalTest) {
        myTesting = true;
        bool closeDialog = false;
        // execute every dialog step
        while (internalTest->getCurrentStep() && !closeDialog &&
                (internalTest->getCurrentStep()->getCategory() == InternalTestStep::Category::DIALOG) &&
                (internalTest->getCurrentStep()->getDialogArgument()->getType() == myType)) {
            // set next step
            const auto testStep = internalTest->setNextStep();
            // continue depending on the dialog argument action
            switch (testStep->getDialogArgument()->getAction()) {
                case InternalTestStep::DialogArgument::Action::ACCEPT:
                    onCmdAccept(internalTest, 0, nullptr);
                    closeDialog = true;
                    break;
                case InternalTestStep::DialogArgument::Action::CANCEL:
                    onCmdCancel(internalTest, 0, nullptr);
                    closeDialog = true;
                    break;
                case InternalTestStep::DialogArgument::Action::RESET:
                    onCmdReset(internalTest, 0, nullptr);
                    break;
                case InternalTestStep::DialogArgument::Action::ABORT:
                    onCmdAbort(nullptr, 0, nullptr);
                    break;
                default:
                    runInternalTest(testStep->getDialogArgument());
                    break;
            }
        }
    } else {
        myTesting = false;
        // continue depending on the dialog type
        if (myOpenType == OpenType::MODAL) {
            // run modal dialog
            getApp()->runModalFor(this);
        }
    }
}
 
 
long
GNEDialog::closeDialogAccepting() {
    // check if stopping modal dialog
    if (!myTesting && (myOpenType == OpenType::MODAL)) {
        getApp()->stopModal(this, TRUE);
    }
    // hide dialog
    hide();
    // set result
    myResult = Result::ACCEPT;
    // restore focus
    if (myParentDialog) {
        myParentDialog->setFocus();
    } else {
        myApplicationWindow->setFocus();
    }
    return 1;
}
 
 
long
GNEDialog::closeDialogCanceling() {
    // check if stopping modal dialog
    if (!myTesting && (myOpenType == OpenType::MODAL)) {
        getApp()->stopModal(this, TRUE);
    }
    // hide dialog
    hide();
    // set result
    myResult = Result::CANCEL;
    // restore focus
    if (myParentDialog) {
        myParentDialog->setFocus();
    } else {
        myApplicationWindow->setFocus();
    }
    return 0;
}
 
 
long
GNEDialog::closeDialogAborting() {
    // check if stopping modal dialog
    if (!myTesting && (myOpenType == OpenType::MODAL)) {
        getApp()->stopModal(this, TRUE);
    }
    // hide dialog
    hide();
    // set result
    myResult = Result::ABORT;
    // restore focus
    if (myParentDialog) {
        myParentDialog->setFocus();
    } else {
        myApplicationWindow->setFocus();
    }
    return 0;
}
 
 
void
GNEDialog::updateTitle(const std::string& newTitle) {
    setTitle(newTitle.c_str());
}
 
 
void
GNEDialog::updateIcon(GUIIcon newIcon) {
    setIcon(GUIIconSubSys::getIcon(newIcon));
}
 
 
void
GNEDialog::buildDialog(GUIIcon titleIcon, GNEDialog::Buttons buttons) {
    // set dialog icon
    setIcon(GUIIconSubSys::getIcon(titleIcon));
    // create main frame
    auto mainFrame = new FXVerticalFrame(this, GUIDesignAuxiliarFrame);
    // create content frame
    myContentFrame = new FXVerticalFrame(mainFrame, GUIDesignDialogContentFrame);
    // add separator
    new FXHorizontalSeparator(mainFrame, GUIDesignHorizontalSeparator);
    // Create frame for buttons
    FXHorizontalFrame* buttonsFrame = new FXHorizontalFrame(mainFrame, GUIDesignDialogButtonsHorizontalFrame);
    // add horizontal frame used to center buttons horizontally
    new FXHorizontalFrame(buttonsFrame, GUIDesignAuxiliarHorizontalFrame);
    // create buttons according to the type
    switch (buttons) {
        case Buttons::OK: {
            // ok button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("OK"), "", TL("OK"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::YES_NO: {
            // yes button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Yes"), "", TL("Yes"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // no button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("No"), "", TL("No"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::YES_NO_CANCEL: {
            // yes button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Yes"), "", TL("Yes"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // no button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("No"), "", TL("No"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // cancel button
            myAbortButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                            GUIIconSubSys::getIcon(GUIIcon::CANCEL), this,
                            MID_GNE_ABORT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::SAVE_DONTSAVE_CANCEL: {
            // save button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Save"), "", TL("Save"),
                             GUIIconSubSys::getIcon(GUIIcon::SAVE), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // don't save button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Don't Save"), "", TL("Don't Save"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // cancel button
            myAbortButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                            GUIIconSubSys::getIcon(GUIIcon::CANCEL), this,
                            MID_GNE_ABORT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::ACCEPT: {
            // accept button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Accept"), "", TL("Accept"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::ACCEPT_CANCEL: {
            // accept button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Accept"), "", TL("Accept"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // cancel button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::ACCEPT_CANCEL_RESET: {
            // accept button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Accept"), "", TL("Accept"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // cancel button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // reset button
            myResetButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Reset"), "", TL("Reset changes"),
                            GUIIconSubSys::getIcon(GUIIcon::RESET), this,
                            MID_GNE_BUTTON_RESET, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::RUN_CANCEL_RESET: {
            // run button
            myRunButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Run"), "", TL("Run"),
                                                    GUIIconSubSys::getIcon(GUIIcon::START), this,
                                                    MID_GNE_BUTTON_RUN, GUIDesignButtonDialog);
            // reset button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                             GUIIconSubSys::getIcon(GUIIcon::NO), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // reset button
            myResetButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Reset"), "", TL("Reset changes"),
                            GUIIconSubSys::getIcon(GUIIcon::RESET), this,
                            MID_GNE_BUTTON_RESET, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myRunButton;
            break;
        }
        case Buttons::RUN_ADVANCED_CANCEL: {
            // run button
            myRunButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Run"), "", TL("Run"),
                                                    GUIIconSubSys::getIcon(GUIIcon::START), this,
                                                    MID_GNE_BUTTON_RUN, GUIDesignButtonDialog);
            // cancel button
            myAdvancedButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Advanced"), "", TL("Advanced options"),
                               GUIIconSubSys::getIcon(GUIIcon::OPTIONS), this,
                               MID_GNE_BUTTON_ADVANCED, GUIDesignButtonDialog);
            // cancel button
            myCancelButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Cancel"), "", TL("Cancel"),
                             GUIIconSubSys::getIcon(GUIIcon::CANCEL), this,
                             MID_GNE_BUTTON_CANCEL, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myRunButton;
            break;
        }
        case Buttons::RERUN_BACK_OK: {
            // run/abort button
            myRunButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Rerun"), "", TL("Rerun tool"),
                                                    GUIIconSubSys::getIcon(GUIIcon::RESET), this,
                                                    MID_GNE_BUTTON_RUN, GUIDesignButtonDialog);
            // back button
            myBackButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Back"), "", TL("Back to tool dialog"),
                           GUIIconSubSys::getIcon(GUIIcon::BACK), this,
                           MID_GNE_BUTTON_BACK, GUIDesignButtonDialog);
            // cancel button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("OK"), "", TL("OK"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        case Buttons::OK_COPY_REPORT: {
            // run/abort button
            myAcceptButton = GUIDesigns::buildFXButton(buttonsFrame, TL("OK"), "", TL("OK"),
                             GUIIconSubSys::getIcon(GUIIcon::YES), this,
                             MID_GNE_BUTTON_ACCEPT, GUIDesignButtonDialog);
            // copy button
            myCopyButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Copy"), "", TL("Copy error trace to clipboard"),
                           GUIIconSubSys::getIcon(GUIIcon::COPY), this,
                           MID_GNE_BUTTON_COPY, GUIDesignButtonDialog);
            // cancel button
            myReportButton = GUIDesigns::buildFXButton(buttonsFrame, TL("Report"), "", TL("Report bug to github"),
                             GUIIconSubSys::getIcon(GUIIcon::GITHUB), this,
                             MID_GNE_BUTTON_REPORT, GUIDesignButtonDialog);
            // set focus button
            myFocusButton = myAcceptButton;
            break;
        }
        default:
            throw ProcessError("Invalid buttons combination in GNEDialog");
    }
    // add horizontal frame used to center buttons horizontally
    new FXHorizontalFrame(buttonsFrame, GUIDesignAuxiliarHorizontalFrame);
}