Create or restore backups. More...
#include <OpenFlipper/BasePlugin/BackupInterface.hh>
Interface definition for general Plugins | |
|
| |
| virtual void | createBackup (int, QString, int &) |
| Tell Backup Plugin to create a backup. | |
| virtual void | createBackup (int, QString) |
| Tell Backup Plugin to create a backup but don't get the id of the object ( if you don't care ). | |
| virtual void | makeBackupPersistent (int, int) |
| Make a backup persistent. | |
| virtual void | restoreObject (int, int _internalId=-1) |
| Tell Backup Plugin to restore a backup. | |
| virtual void | slotBackup (int, QString, int) |
| Backup for an object requested. | |
| virtual void | slotAboutToRestore (int, int) |
| A given object will be restored. | |
| virtual void | slotRestore (int, int) |
| Restore Object. | |
| virtual void | slotRestored (int, int) |
| Object fully restored. | |
| virtual | ~BackupInterface () |
| Destructor. | |
Interface definition for Backup Plugins | |
These signals and slots have to be implemented if you create a plugin managing Backups ( A Backup plugin is already provided by OpenFlipper so you don't need to use these funcions). | |
| virtual void | aboutToRestore (int, int) |
| Backup Plugin tells other Plugins that a restore will happen. | |
| virtual void | restore (int, int) |
| Backup Plugin tells other Plugins that they should restore their own data. | |
| virtual void | restored (int, int) |
| Backup Plugin tells other Plugins that a restore has happened. | |
| virtual void | slotRestoreObject (int, QString, int) |
| Restore the core object. | |
| virtual void | slotMakeBackupPersistent (int, int) |
Create or restore backups.
Interface Class for Backup Plugins. The Backup Interface can be used to communicate with or write a backup plugin.
Definition at line 67 of file BackupInterface.hh.
| virtual void BackupInterface::aboutToRestore | ( | int | , | |
| int | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that a restore will happen.
Definition at line 172 of file BackupInterface.hh.
| virtual void BackupInterface::createBackup | ( | int | , | |
| QString | ||||
| ) | [inline, virtual, signal] |
Tell Backup Plugin to create a backup but don't get the id of the object ( if you don't care ).
Plugins which supports backups can call this function if they want to create backups.
A Backup control Plugin will do the rest.
| _objectid | Identifier of the object to create the backup | |
| _name | Name of the Backup, to show the user what can be recovered |
Definition at line 86 of file BackupInterface.hh.
| virtual void BackupInterface::createBackup | ( | int | , | |
| QString | , | |||
| int & | ||||
| ) | [inline, virtual, signal] |
Tell Backup Plugin to create a backup.
Plugins which supports backups can call this function if they want to create backups.
A Backup control Plugin will do the rest.
| _objectid | Identifier of the object to create the backup | |
| _name | Name of the Backup, to show the user what can be recovered | |
| _internalId | A unique identifier for the created backup |
Definition at line 77 of file BackupInterface.hh.
| virtual void BackupInterface::makeBackupPersistent | ( | int | , | |
| int | ||||
| ) | [inline, virtual, signal] |
Make a backup persistent.
A persistent backup will not be removed automatically by the backup plugin. You have to remove it by yourself by calling removeBackup!
Definition at line 94 of file BackupInterface.hh.
| virtual void BackupInterface::restore | ( | int | , | |
| int | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that they should restore their own data.
Definition at line 177 of file BackupInterface.hh.
| virtual void BackupInterface::restored | ( | int | , | |
| int | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that a restore has happened.
Definition at line 182 of file BackupInterface.hh.
| virtual void BackupInterface::restoreObject | ( | int | , | |
| int | _internalId = -1 | |||
| ) | [inline, virtual, signal] |
Tell Backup Plugin to restore a backup.
Plugins which supports backups can this function if they want to restore backups.
A Backup control Plugin will do the rest.
| _objectid | Identifier of the object to restore | |
| _internalId | The unique identifier of the restore set (-1 for last backup) |
Definition at line 103 of file BackupInterface.hh.
| virtual void BackupInterface::slotAboutToRestore | ( | int | , | |
| int | ||||
| ) | [inline, private, virtual, slot] |
A given object will be restored.
This function is called before an object is restored from a backup. perObjectDatas and the object will be reset to the backup state after this function is called for all plugins. If you have any pointers or references to the given object you have to clean them up here.
| _id | Identifier of the object which is about to be restored | |
| _name | Name of the restore set | |
| _internalId | Unique Number of the Restore set |
Definition at line 127 of file BackupInterface.hh.
| virtual void BackupInterface::slotBackup | ( | int | , | |
| QString | , | |||
| int | ||||
| ) | [inline, private, virtual, slot] |
Backup for an object requested.
This function will be called if a plugin requests a backup. You can also react on this event if you reimplement this function in your plugin.
| _id | Identifier of the object to create the backup | |
| _name | Name of the Backup, to show the user what can be recovered | |
| _internalId | Unique identifier of the backup. This number is generated by the core and returned by the original signal. |
Definition at line 114 of file BackupInterface.hh.
| virtual void BackupInterface::slotRestore | ( | int | , | |
| int | ||||
| ) | [inline, private, virtual, slot] |
Restore Object.
This function is called after the main object is restored from a backup. perObjectDatas and the object have been reset to the backup state.
Here you can restore additional data which is not managed in perObjectDatas but in your local plugin.
| _objectid | Identifier of the object which is about to be restored | |
| _name | Name of the restore set | |
| _internalId | Unique Number of the Restore set |
Definition at line 141 of file BackupInterface.hh.
| virtual void BackupInterface::slotRestored | ( | int | , | |
| int | ||||
| ) | [inline, private, virtual, slot] |
Object fully restored.
This function is called after an object and all data from other plugins is restored from a backup. perObjectDatas and the object have been reset to the backup state.
| _objectid | Identifier of the object which is about to be restored | |
| _name | Name of the restore set | |
| _internalId | Unique Number of the Restore set |
Definition at line 152 of file BackupInterface.hh.
| virtual void BackupInterface::slotRestoreObject | ( | int | , | |
| QString | , | |||
| int | ||||
| ) | [inline, private, virtual, slot] |
Restore the core object.
This function has to be implemented in the backup management plugin. Normally this function is provided by the default backup plugin and should not be used! To restore data in your plugin use the slotRestore above.
| _objectId | Object to restore |
Definition at line 195 of file BackupInterface.hh.
1.6.3