BackupData.hh 5.04 KB
Newer Older
Dirk Wilden's avatar
Dirk Wilden committed
1
2
3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen       *
Dirk Wilden's avatar
Dirk Wilden committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
Jan Möbius's avatar
Jan Möbius committed
37
38
39
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
Dirk Wilden's avatar
Dirk Wilden committed
40
41
42
43
44
45
46
47
48
49
*                                                                            *
\*===========================================================================*/

#ifndef BACKUPDATA_HH
#define BACKUPDATA_HH

#include <QString>
#include <OpenFlipper/common/perObjectData.hh>
#include <OpenFlipper/common/UpdateType.hh>
#include <OpenFlipper/common/BaseBackup.hh>
Jan Möbius's avatar
Jan Möbius committed
50
#include <OpenFlipper/common/GlobalDefines.hh>
Dirk Wilden's avatar
Dirk Wilden committed
51
52
53
54
55
56
57
58

#define OBJECT_BACKUPS "Object Backups"

/**
 * @brief Abstract class that is used to store backups
 *
 * The default implementation can only backup perObjectDatas
 */
Jan Möbius's avatar
Jan Möbius committed
59
class DLLEXPORT BackupData : public PerObjectData
Dirk Wilden's avatar
Dirk Wilden committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{

  public:
    /// Constructor
    BackupData(BaseObjectData* _object = 0);
    /// Destructor
    virtual ~BackupData();

  public:
    /// store a backup
    void storeBackup(BaseBackup* _backup);

    /// perform an undo if possible
    void undo();
    /// perform a redo if possible
    void redo();

    /// return the id of the next undo backup
    int undoID();
    /// return the id of the next redo backup
    int redoID();
    /// return the id of the current backup state
    int currentID();
    
    /// return the name of the next undo backup
    QString undoName();
    /// return the name of the next redo backup
    QString redoName();

    /// return if an undo backup is available
    bool undoAvailable();
    /// return if a redo backup is available
    bool redoAvailable();

    /// return if an undo backup is blocked
    bool undoBlocked();
    /// return if a redo backup is blocked
    bool redoBlocked();

    /// remove all backups
    void clear();

    /// add links to other backups for the current state
    /// this is used to ensure that the backups are only applied simultaneously
    void setLinks(IdList _objectIDs);

    /// return the current state
    BaseBackup* currentState();

Matthias Möller's avatar
Matthias Möller committed
109
110
111
112
113
114
    /// return the maximum of backups which are saved
    size_t maxBackups();

    /// set the maximum of saved backups
    void setMaxBackups(size_t _max);

Dirk Wilden's avatar
Dirk Wilden committed
115
116
117
118
119
120
  protected:
    std::vector< BaseBackup* > undoStates_;
    std::vector< BaseBackup* > redoStates_;
    BaseBackup* currentState_;

    BaseObjectData* object_;
Matthias Möller's avatar
Matthias Möller committed
121
122

    size_t maxBackups_;
Dirk Wilden's avatar
Dirk Wilden committed
123
124
125
};

#endif //BACKUPDATA_HH