GNETemplateElementDialog.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 template based on GNEDialog used for editing elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/dialogs/GNEDialog.h>
#include <netedit/GNETagPropertiesDatabase.h>
 
// ===========================================================================
// class definitions
// ===========================================================================
 
template <typename T>
class GNETemplateElementDialog : public GNEDialog {
 
public:
    GNETemplateElementDialog(T* element) :
        GNEDialog(element->getNet()->getViewNet()->getViewParent()->getGNEAppWindows(),
                  TLF("Edit % '%'", element->getTagStr(), element->getID()).c_str(),
                  element->getTagProperty()->getGUIIcon(),
                  Buttons::ACCEPT_CANCEL_RESET, OpenType::MODAL, ResizeMode::STATIC),
        myElement(element),
        myChangesDescription(TLF("change % values", element->getTagStr())) {
        // init commandGroup
        myElement->getNet()->getViewNet()->getUndoList()->begin(myElement, myChangesDescription);
    }
 
    ~GNETemplateElementDialog() {}
 
    T* getElement() const {
        return myElement;
    }
 
    virtual void runInternalTest(const InternalTestStep::DialogArgument* dialogArgument) = 0;
 
    virtual long onCmdAccept(FXObject* sender, FXSelector sel, void* ptr) = 0;
 
    virtual long onCmdReset(FXObject*, FXSelector, void*) = 0;
 
    long onCmdCancel(FXObject*, FXSelector, void*) {
        myElement->getNet()->getViewNet()->getUndoList()->abortLastChangeGroup();
        return closeDialogCanceling();
    }
 
    long onCmdAbort(FXObject*, FXSelector, void*) {
        myElement->getNet()->getViewNet()->getUndoList()->abortLastChangeGroup();
        return closeDialogAborting();
    }
 
 
protected:
    GNETemplateElementDialog() :
        GNEDialog() {}
 
    T* myElement = nullptr;
 
    long acceptElementDialog() {
        myElement->getNet()->getViewNet()->getUndoList()->end();
        return closeDialogAccepting();
    }
 
    void resetChanges() {
        // abort last command group an start editing again
        myElement->getNet()->getViewNet()->getUndoList()->abortLastChangeGroup();
        myElement->getNet()->getViewNet()->getUndoList()->begin(myElement, myChangesDescription);
    }
 
private:
    std::string myChangesDescription;
 
    GNETemplateElementDialog(const GNETemplateElementDialog&) = delete;
 
    GNETemplateElementDialog& operator=(const GNETemplateElementDialog&) = delete;
};