BackupInterface Class Reference
Create or restore backups. More...
#include <OpenFlipper/BasePlugin/BackupInterface.hh>
Interface definition for general Plugins | |
|
| |
| virtual void | createBackup (int, QString, UpdateType=UPDATE_ALL) |
| Tell Backup Plugin to create a backup. | |
| virtual void | createBackup (IdList, QString, std::vector< UpdateType >) |
| Tell Backup Plugin to create a backup. | |
| virtual void | undo (int) |
| Tell Backup Plugin to undo the last action of an object. | |
| virtual void | redo (int) |
| Tell Backup Plugin to redo the last action on an object. | |
| virtual void | undo () |
| Tell Backup Plugin to undo the last action. | |
| virtual void | redo () |
| Tell Backup Plugin to redo the last action. | |
| virtual void | slotCreateBackup (int, QString, UpdateType=UPDATE_ALL) |
| Backup for an object requested. | |
| virtual void | slotCreateBackup (IdList, QString, std::vector< UpdateType >) |
| Backup for an object requested. | |
| virtual void | slotAboutToRestore (int, UpdateType) |
| A given object will be restored. | |
| virtual void | slotRestore (int, UpdateType) |
| Restore Object. | |
| virtual void | slotRestored (int, UpdateType) |
| 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, UpdateType) |
| Backup Plugin tells other Plugins that a restore will happen. | |
| virtual void | restore (int, UpdateType) |
| Backup Plugin tells other Plugins that they should restore their own data. | |
| virtual void | restored (int, UpdateType) |
| Backup Plugin tells other Plugins that a restore has happened. | |
| 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 | slotUndo (int) |
| Undo the last action of an object. | |
| virtual void | slotRedo (int) |
| Redo the last action on an object. | |
| virtual void | slotUndo () |
| Undo the last action. | |
| virtual void | slotRedo () |
| Redo the last action. | |
Detailed Description
Create or restore backups.
Interface Class for Backup Plugins. The Backup Interface can be used to communicate with or write a backup plugin.
See tutorial Tracking changes of an object: The Backup Plugin for detailed information on how to use this plugin interface.
Definition at line 56 of file BackupInterface.hh.
Member Function Documentation
| virtual void BackupInterface::aboutToRestore | ( | int | , | |
| UpdateType | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that a restore will happen.
Reimplemented in BackupPlugin.
Definition at line 185 of file BackupInterface.hh.
| virtual void BackupInterface::createBackup | ( | IdList | , | |
| QString | , | |||
| std::vector< UpdateType > | ||||
| ) | [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.
- Parameters:
-
_objectids Identifier of the object to create the backup _name Name of the Backup, to show the user what can be recovered
Definition at line 81 of file BackupInterface.hh.
| virtual void BackupInterface::createBackup | ( | int | , | |
| QString | , | |||
| UpdateType | = UPDATE_ALL | |||
| ) | [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.
- Parameters:
-
_objectid Identifier of the object to create the backup _name Name of the Backup, to show the user what can be recovered
Reimplemented in DecimaterPlugin, IsotropicRemesherPlugin, MeshRepairPlugin, MovePlugin, BSplineCurveSelectionPlugin, BSplineSurfaceSelectionPlugin, MeshObjectSelectionPlugin, SmootherPlugin, SkeletonEditingPlugin, SmootherPlugin, SubdividerPlugin, and TopologyPlugin.
Definition at line 72 of file BackupInterface.hh.
| virtual void BackupInterface::generateBackup | ( | int | _id, | |
| QString | _name, | |||
| UpdateType | _type | |||
| ) | [inline, virtual, signal] |
This signal is emitted by a BackupPlugin and tells a TypePlugin to generate a backup.
- Parameters:
-
_id Id of the added object _type the type of backup that needs to be done
Reimplemented in BackupPlugin.
Definition at line 245 of file BackupInterface.hh.
| virtual void BackupInterface::redo | ( | ) | [inline, virtual, signal] |
Tell Backup Plugin to redo the last action.
Plugins which supports backups can call this function if they want to restore backups.
A Backup control Plugin will do the rest.
Reimplemented in BackupPlugin.
Definition at line 111 of file BackupInterface.hh.
| virtual void BackupInterface::redo | ( | int | ) | [inline, virtual, signal] |
Tell Backup Plugin to redo the last action on an object.
Plugins which supports backups can call this function if they want to restore backups.
A Backup control Plugin will do the rest.
- Parameters:
-
_objectid Identifier of the object to restore
Reimplemented in BackupPlugin.
Definition at line 97 of file BackupInterface.hh.
| virtual void BackupInterface::restore | ( | int | , | |
| UpdateType | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that they should restore their own data.
Reimplemented in BackupPlugin.
Definition at line 190 of file BackupInterface.hh.
| virtual void BackupInterface::restored | ( | int | , | |
| UpdateType | ||||
| ) | [inline, virtual, signal] |
Backup Plugin tells other Plugins that a restore has happened.
Reimplemented in BackupPlugin.
Definition at line 195 of file BackupInterface.hh.
| virtual void BackupInterface::slotAboutToRestore | ( | int | , | |
| UpdateType | ||||
| ) | [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.
- Parameters:
-
_id Identifier of the object which is about to be restored
Definition at line 144 of file BackupInterface.hh.
| virtual void BackupInterface::slotCreateBackup | ( | IdList | , | |
| QString | , | |||
| std::vector< UpdateType > | ||||
| ) | [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.
- Parameters:
-
_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.
Reimplemented in BackupPlugin.
Definition at line 133 of file BackupInterface.hh.
| virtual void BackupInterface::slotCreateBackup | ( | int | , | |
| QString | , | |||
| UpdateType | = UPDATE_ALL | |||
| ) | [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.
- Parameters:
-
_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.
Reimplemented in BackupPlugin.
Definition at line 123 of file BackupInterface.hh.
| virtual void BackupInterface::slotRedo | ( | ) | [inline, private, virtual, slot] |
Redo the last action.
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.
Reimplemented in BackupPlugin.
Definition at line 237 of file BackupInterface.hh.
| virtual void BackupInterface::slotRedo | ( | int | ) | [inline, private, virtual, slot] |
Redo the last action on an 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.
- Parameters:
-
_objectid Identifier of the object to restore
Reimplemented in BackupPlugin.
Definition at line 219 of file BackupInterface.hh.
| virtual void BackupInterface::slotRestore | ( | int | , | |
| UpdateType | ||||
| ) | [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.
- Parameters:
-
_objectid Identifier of the object which is about to be restored
Definition at line 156 of file BackupInterface.hh.
| virtual void BackupInterface::slotRestored | ( | int | , | |
| UpdateType | ||||
| ) | [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.
- Parameters:
-
_objectid Identifier of the object which is about to be restored
Definition at line 165 of file BackupInterface.hh.
| virtual void BackupInterface::slotUndo | ( | ) | [inline, private, virtual, slot] |
Undo the last action.
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.
Reimplemented in BackupPlugin.
Definition at line 228 of file BackupInterface.hh.
| virtual void BackupInterface::slotUndo | ( | int | ) | [inline, private, virtual, slot] |
Undo the last action of an 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.
- Parameters:
-
_objectid Identifier of the object to restore
Reimplemented in BackupPlugin.
Definition at line 209 of file BackupInterface.hh.
| virtual void BackupInterface::undo | ( | ) | [inline, virtual, signal] |
Tell Backup Plugin to undo the last action.
Plugins which supports backups can call this function if they want to restore backups.
A Backup control Plugin will do the rest.
Reimplemented in BackupPlugin.
Definition at line 104 of file BackupInterface.hh.
| virtual void BackupInterface::undo | ( | int | ) | [inline, virtual, signal] |
Tell Backup Plugin to undo the last action of an object.
Plugins which supports backups can call this function if they want to restore backups.
A Backup control Plugin will do the rest.
- Parameters:
-
_objectid Identifier of the object to restore
Reimplemented in BackupPlugin.
Definition at line 89 of file BackupInterface.hh.
The documentation for this class was generated from the following file:
- OpenFlipper/BasePlugin/BackupInterface.hh
