Developer Documentation
BackupData.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef BACKUPDATA_HH
51 #define BACKUPDATA_HH
52 
53 #include <QString>
55 #include <OpenFlipper/common/UpdateType.hh>
56 #include <OpenFlipper/common/BaseBackup.hh>
58 
59 #define OBJECT_BACKUPS "Object Backups"
60 
67 {
68 
69  public:
71  BackupData(BaseObjectData* _object = 0);
73  virtual ~BackupData();
74 
75  public:
77  void storeBackup(BaseBackup* _backup);
78 
80  void undo();
82  void redo();
83 
85  int undoID();
87  int redoID();
89  int currentID();
90 
92  QString undoName();
94  QString redoName();
95 
97  bool undoAvailable();
99  bool redoAvailable();
100 
102  bool undoBlocked();
104  bool redoBlocked();
105 
107  void clear();
108 
111  void setLinks(IdList _objectIDs);
112 
114  BaseBackup* currentState();
115 
117  size_t maxBackups();
118 
120  void setMaxBackups(size_t _max);
121 
122  protected:
123  std::vector< BaseBackup* > undoStates_;
124  std::vector< BaseBackup* > redoStates_;
125  BaseBackup* currentState_;
126 
127  BaseObjectData* object_;
128 
129  size_t maxBackups_;
130 };
131 
132 #endif //BACKUPDATA_HH
#define DLLEXPORT
Abstract class that is used to store backups.
Definition: BackupData.hh:66
Class that encapsulates a backup.
Definition: BaseBackup.hh:62
Object Payload.
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:192