GNEUndoList.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 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
/****************************************************************************/
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <stack>
#include <string>
 
#include <netedit/changes/GNEChangeGroup.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GNEChange;
class GNEChange_Attribute;
class GNEApplicationWindow;
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEUndoList : public GNEChangeGroup {
    FXDECLARE_ABSTRACT(GNEUndoList)
 
public:
    class Iterator {
 
    public:
        ~Iterator();
 
        bool end() const;
 
        int getIndex() const;
 
        const std::string getDescription() const;
 
        const std::string getTimeStamp() const;
 
        FXIcon* getIcon() const;
 
        Iterator& operator++(int);
 
    protected:
        Iterator(GNEChange* change);
 
    private:
        Iterator();
 
        GNEChange* myCurrentChange;
 
        int myIndex;
    };
 
    class UndoIterator : public Iterator {
 
    public:
        UndoIterator(const GNEUndoList* undoList);
    };
 
    class RedoIterator : public Iterator {
 
    public:
        RedoIterator(const GNEUndoList* undoList);
    };
 
    GNEUndoList(GNEApplicationWindow* parent);
 
    ~GNEUndoList();
 
    void undo();
 
    void redo();
 
    std::string undoName() const;
 
    std::string redoName() const;
 
    void begin(GUIIcon icon, const std::string& description);
 
    void begin(const GNEAttributeCarrier* AC, const std::string& description);
 
    void begin(Supermode supermode, GUIIcon icon, const std::string& description);
 
    void end();
 
    void add(GNEChange* command, bool doit = false, bool merge = true);
 
    /* @brief clears the undo list (implies abort)
     * All undo and redo information will be destroyed.
     */
    void clear();
 
    void abortAllChangeGroups();
 
    void abortLastChangeGroup();
 
    int currentCommandGroupSize() const;
 
    Supermode getUndoSupermode() const;
 
    Supermode getRedoSupermode() const;
 
    bool hasCommandGroup() const;
 
    bool busy() const;
 
    long onCmdUndo(FXObject*, FXSelector, void*);
 
    long onUpdUndo(FXObject*, FXSelector, void*);
 
    long onCmdRedo(FXObject*, FXSelector, void*);
 
    long onUpdRedo(FXObject*, FXSelector, void*);
 
protected:
    void cut();
 
    void abortCurrentSubGroup();
 
    bool canUndo() const;
 
    bool canRedo() const;
 
private:
    bool myWorking;
 
    // @brief the stack of currently active change groups
    std::stack<GNEChangeGroup*> myChangeGroups;
 
    // @brief the parent GNEApplicationWindow for this undolist
    GNEApplicationWindow* const myGNEApplicationWindowParent;
};