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 #pragma once
43
44 #include <OpenFlipper/common/Types.hh>
45
59 class BackupInterface {
60
61 //===========================================================================
64 //===========================================================================
65
66 signals:
67
77 virtual void createBackup( int _objectid, QString _name, UpdateType _type = UPDATE_ALL){};
78
91 virtual void createBackup( IdList _objectids, QString _name, std::vector<UpdateType> _types){};
92
99 virtual void undo(int _objectid) {};
100
107 virtual void redo(int _objectid) {};
108
114 virtual void undo(){};
115
121 virtual void redo(){};
122
123 private slots:
124
134 virtual void slotCreateBackup( int _objectid , QString _name , UpdateType _type = UPDATE_ALL) {};
135
145 virtual void slotCreateBackup( IdList _objectids , QString _name , std::vector<UpdateType> _types) {};
146
158 virtual void slotAboutToRestore( int _objectid ) {};
159
169 virtual void slotRestored( int _objectid ) {};
170
171 public:
172
174 virtual ~BackupInterface() {};
175
178 //===========================================================================
185 //===========================================================================
186
187 signals:
191 virtual void aboutToRestore(int _objectid ) {};
192
196 virtual void restored( int _objectid ) {};
197
198
199 private slots:
200
201
210 virtual void slotUndo(int _objectid) {};
211
220 virtual void slotRedo(int _objectid) {};
221
229 virtual void slotUndo(){};
230
238 virtual void slotRedo(){};
239
240 signals:
241
248 virtual void generateBackup( int _id, QString _name, UpdateType _type ) {};
249
252 };
253
300 Q_DECLARE_INTERFACE(BackupInterface,"GUI.BackupInterface/1.1")
UpdateType
Update type class.
Definition: UpdateType.hh:60
BackupInterface::aboutToRestore
virtual void aboutToRestore(int _objectid)
Backup Plugin tells other Plugins that a restore will happen.
Definition: BackupInterface.hh:191
UPDATE_ALL
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
BackupInterface::redo
virtual void redo(int _objectid)
Tell Backup Plugin to redo the last action on an object.
Definition: BackupInterface.hh:107
BackupInterface::undo
virtual void undo(int _objectid)
Tell Backup Plugin to undo the last action of an object.
Definition: BackupInterface.hh:99
BackupInterface::slotAboutToRestore
virtual void slotAboutToRestore(int _objectid)
A given object will be restored.
Definition: BackupInterface.hh:158
BackupInterface::~BackupInterface
virtual ~BackupInterface()
Destructor.
Definition: BackupInterface.hh:174
BackupInterface::restored
virtual void restored(int _objectid)
Backup Plugin tells other Plugins that a restore has happened.
Definition: BackupInterface.hh:196
BackupInterface::slotRedo
virtual void slotRedo()
Redo the last action.
Definition: BackupInterface.hh:238
BackupInterface::slotCreateBackup
virtual void slotCreateBackup(IdList _objectids, QString _name, std::vector< UpdateType > _types)
Backup for an object requested.
Definition: BackupInterface.hh:145
BackupInterface::redo
virtual void redo()
Tell Backup Plugin to redo the last action.
Definition: BackupInterface.hh:121
BackupInterface::slotRedo
virtual void slotRedo(int _objectid)
Redo the last action on an object.
Definition: BackupInterface.hh:220
IdList
std::vector< int > IdList
Standard Type for id Lists used for scripting.
Definition: DataTypes.hh:179
BackupInterface::slotUndo
virtual void slotUndo()
Undo the last action.
Definition: BackupInterface.hh:229
BackupInterface::slotUndo
virtual void slotUndo(int _objectid)
Undo the last action of an object.
Definition: BackupInterface.hh:210
Types.hh
BackupInterface::createBackup
virtual void createBackup(IdList _objectids, QString _name, std::vector< UpdateType > _types)
Tell Backup Plugin to create a group backup.
Definition: BackupInterface.hh:91
BackupInterface::undo
virtual void undo()
Tell Backup Plugin to undo the last action.
Definition: BackupInterface.hh:114
BackupInterface::generateBackup
virtual void generateBackup(int _id, QString _name, UpdateType _type)
This signal is emitted by a BackupPlugin and tells a TypePlugin to generate a backup.
Definition: BackupInterface.hh:248
BackupInterface::createBackup
virtual void createBackup(int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
Tell Backup Plugin to create a backup.
Definition: BackupInterface.hh:77
BackupInterface::slotCreateBackup
virtual void slotCreateBackup(int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
Backup for an object requested.
Definition: BackupInterface.hh:134
BackupInterface::slotRestored
virtual void slotRestored(int _objectid)
Object fully restored.
Definition: BackupInterface.hh:169
BackupInterface
Interface class for backup handling.
Definition: BackupInterface.hh:59