/*===========================================================================*\ * * * OpenFlipper * * Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen * * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * * \*===========================================================================*/ /*===========================================================================*\ * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * * \*===========================================================================*/ // // C++ Interface: Backup Interface // // Description: // // // Author: Jan Moebius , (C) 2007 // #ifndef BACKUPPLUGININTERFACE_HH #define BACKUPPLUGININTERFACE_HH #include #include #include /** \brief 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 \ref ex6 for detailed information on how to use this plugin interface. * */ class BackupInterface { //=========================================================================== /** @name Interface definition for general Plugins * @{ */ //=========================================================================== signals: /** \brief Tell Backup Plugin to create a backup group * * A backup group can be used to combine multiple object backups into * one backup group and undo all of them at once * * @param _name Name of the Backup group, to show the user what can be recovered * @param _groupId A unique identifier for the created backup group */ virtual void createBackupGroup(QString /*_name*/, int& /*_groupId*/) {}; /** \brief Tell Backup Plugin to create a backup * * Plugins which supports backups can call this function if they want to create backups.\n * A Backup control Plugin will do the rest. * @param _objectid Identifier of the object to create the backup * @param _name Name of the Backup, to show the user what can be recovered * @param _internalId A unique identifier for the created backup */ virtual void createBackup( int /*_objectid*/, QString /*_name*/, int& /*_internalId*/, int /*_groupId*/ = -1) {}; /** \brief 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.\n * A Backup control Plugin will do the rest. * @param _objectid Identifier of the object to create the backup * @param _name Name of the Backup, to show the user what can be recovered */ virtual void createBackup( int /*_objectid*/, QString /*_name*/) {}; /** \brief 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! */ virtual void makeBackupPersistent(int /*_objectid*/, int /*_internalId*/){}; /** \brief Tell Backup Plugin to restore a backup * * Plugins which supports backups can call this function if they want to restore backups.\n * A Backup control Plugin will do the rest. * @param _objectid Identifier of the object to restore * @param _internalId The unique identifier of the restore set (-1 for last backup) */ virtual void restoreObject( int /*_objectid*/, int /*_internalId*/ =-1) {}; /** \brief Tell Backup Plugin to restore a backup group * * Plugins which supports backups can call this function if they want to restore backups.\n * A Backup control Plugin will do the rest. * @param _groupId Identifier of the group to restore */ virtual void restoreGroup( int /*_groupId*/ ) {}; private slots: /** \brief 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. * @param _id Identifier of the object to create the backup * @param _name Name of the Backup, to show the user what can be recovered * @param _internalId Unique identifier of the backup. This number is generated by the core and returned by the original signal. */ virtual void slotBackup( int /*_objectid*/ , QString /*_name*/ , int /*_internalId*/, int /*_groupId*/ = -1) {}; /** \brief Backup group requested * * This function will be called if a plugin requests a backup group. You can * also react on this event if you reimplement this function in your plugin. * * @param _name Name of the Backup group, to show the user what can be recovered * @param _groupId Unique identifier of the backup group. This number is generated by the core and returned by the original signal. */ virtual void slotBackupGroup( QString /*_name*/ , int /*_groupId*/) {}; /** \brief 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. * @param _id Identifier of the object which is about to be restored * @param _internalId Unique Number of the Restore set */ virtual void slotAboutToRestore( int /*_objectid*/ , int /*_internalId*/) {}; /** \brief 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.\n * * Here you can restore additional data which is not managed in perObjectDatas but * in your local plugin.\n * * @param _objectid Identifier of the object which is about to be restored * @param _internalId Unique Number of the Restore set */ virtual void slotRestore( int /*_objectid*/ , int /*_internalId*/) {}; /** \brief 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. * @param _objectid Identifier of the object which is about to be restored * @param _internalId Unique Number of the Restore set */ virtual void slotRestored( int /*_objectid*/, int /*_internalId*/) {}; public : /// Destructor virtual ~BackupInterface() {}; //=========================================================================== /** @name 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). * @{ */ //=========================================================================== signals: /** \brief Backup Plugin tells other Plugins that a restore will happen * */ virtual void aboutToRestore(int /*_objectid*/ , int /*_internalId*/) {}; /** \brief Backup Plugin tells other Plugins that they should restore their own data * */ virtual void restore(int /*_objectid*/ , int /*_internalId*/) {}; /** \brief Backup Plugin tells other Plugins that a restore has happened * */ virtual void restored( int /*_objectid*/ , int /*_internalId*/) {}; private slots: /** \brief 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. * * @param _objectId Object to restore * */ virtual void slotRestoreObject(int /*_objectid*/, int /*_internalId*/) {}; /** \brief Restore the a group * * 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. * * @param _groupId group to restore * */ virtual void slotRestoreGroup(int /*_groupid*/) {}; virtual void slotMakeBackupPersistent(int /*_objectid*/, int /*_internalId*/) {}; }; Q_DECLARE_INTERFACE(BackupInterface,"GUI.BackupInterface/1.0") #endif // BACKUPPLUGININTERFACE_HH