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 #pragma once
43
44 #include <QString>
45 #include <OpenFlipper/common/perObjectData.hh>
46 #include <OpenFlipper/common/UpdateType.hh>
47 #include <OpenFlipper/common/BaseBackup.hh>
48 #include <OpenFlipper/common/GlobalDefines.hh>
49
50 #define OBJECT_BACKUPS "Object Backups"
51
57 class DLLEXPORT BackupData : public PerObjectData
58 {
59
60 public:
62 explicit BackupData(BaseObjectData* _object = 0);
64 virtual ~BackupData();
65
66 public:
68 void storeBackup(BaseBackup* _backup);
69
71 void undo();
73 void redo();
74
76 int undoID();
78 int redoID();
80 int currentID();
81
83 QString undoName();
85 QString redoName();
86
88 bool undoAvailable();
90 bool redoAvailable();
91
93 bool undoBlocked();
95 bool redoBlocked();
96
98 void clear();
99
102 void setLinks(IdList _objectIDs);
103
105 BaseBackup* currentState();
106
108 size_t maxBackups();
109
111 void setMaxBackups(size_t _max);
112
113 protected:
114 std::vector< BaseBackup* > undoStates_;
115 std::vector< BaseBackup* > redoStates_;
116 BaseBackup* currentState_;
117
118 BaseObjectData* object_;
119
120 size_t maxBackups_;
121 };
122
DLLEXPORT
#define DLLEXPORT
Definition: GlobalDefines.hh:95
PerObjectData
Object Payload.
Definition: perObjectData.hh:73
IdList
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
BackupData
Abstract class that is used to store backups.
Definition: BackupData.hh:57
BaseObjectData
Definition: BaseObjectData.hh:102
perObjectData.hh
BaseBackup
Class that encapsulates a backup.
Definition: BaseBackup.hh:53
GlobalDefines.hh