Developer Documentation
BackupInterface.hh
Go to the documentation of this file.
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 BACKUPPLUGININTERFACE_HH
51 #define BACKUPPLUGININTERFACE_HH
52 
53 
55 
56 #if QT_VERSION >= 0x050000
57  #include <QtWidgets>
58 #else
59  #include <QtGui>
60 #endif
61 
76 
77  //===========================================================================
80  //===========================================================================
81 
82  signals:
83 
93  virtual void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL){};
94 
107  virtual void createBackup( IdList _objectids, QString _name, std::vector<UpdateType> _types){};
108 
115  virtual void undo(int _objectid) {};
116 
123  virtual void redo(int _objectid) {};
124 
130  virtual void undo(){};
131 
137  virtual void redo(){};
138 
139  private slots:
140 
150  virtual void slotCreateBackup( int _objectid , QString _name , UpdateType _type = UPDATE_ALL) {};
151 
161  virtual void slotCreateBackup( IdList _objectids , QString _name , std::vector<UpdateType> _types) {};
162 
174  virtual void slotAboutToRestore( int _objectid ) {};
175 
185  virtual void slotRestored( int _objectid ) {};
186 
187  public:
188 
190  virtual ~BackupInterface() {};
191 
194  //===========================================================================
201  //===========================================================================
202 
203  signals:
207  virtual void aboutToRestore(int _objectid ) {};
208 
212  virtual void restored( int _objectid ) {};
213 
214 
215  private slots:
216 
217 
226  virtual void slotUndo(int _objectid) {};
227 
236  virtual void slotRedo(int _objectid) {};
237 
245  virtual void slotUndo(){};
246 
254  virtual void slotRedo(){};
255 
256  signals:
257 
264  virtual void generateBackup( int _id, QString _name, UpdateType _type ) {};
265 
268 };
269 
316 Q_DECLARE_INTERFACE(BackupInterface,"GUI.BackupInterface/1.1")
317 
318 #endif // BACKUPPLUGININTERFACE_HH
virtual void undo(int _objectid)
Tell Backup Plugin to undo the last action of an object.
virtual void generateBackup(int _id, QString _name, UpdateType _type)
This signal is emitted by a BackupPlugin and tells a TypePlugin to generate a backup.
virtual void redo(int _objectid)
Tell Backup Plugin to redo the last action on an object.
virtual void slotAboutToRestore(int _objectid)
A given object will be restored.
virtual void slotUndo(int _objectid)
Undo the last action of an object.
virtual void slotRedo()
Redo the last action.
virtual void slotCreateBackup(int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
Backup for an object requested.
virtual void slotRestored(int _objectid)
Object fully restored.
virtual void restored(int _objectid)
Backup Plugin tells other Plugins that a restore has happened.
Update type class.
Definition: UpdateType.hh:70
virtual void redo()
Tell Backup Plugin to redo the last action.
virtual void createBackup(IdList _objectids, QString _name, std::vector< UpdateType > _types)
Tell Backup Plugin to create a group backup.
virtual void undo()
Tell Backup Plugin to undo the last action.
virtual void slotCreateBackup(IdList _objectids, QString _name, std::vector< UpdateType > _types)
Backup for an object requested.
virtual void aboutToRestore(int _objectid)
Backup Plugin tells other Plugins that a restore will happen.
virtual void slotRedo(int _objectid)
Redo the last action on an object.
virtual void slotUndo()
Undo the last action.
virtual ~BackupInterface()
Destructor.
virtual void createBackup(int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
Tell Backup Plugin to create a backup.
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:192
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
Interface class for backup handling.