Developer Documentation
BackupPlugin Class Reference
Inheritance diagram for BackupPlugin:
PythonInterface OptionsInterface ContextMenuInterface LoadSaveInterface ToolbarInterface LoggingInterface BackupInterface MenuInterface KeyInterface BaseInterface

Public Slots

QString version ()
 

Signals

void updateView ()
 
void updatedObject (int _identifier, const UpdateType &_type)
 
void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 
void log (Logtype _type, QString _message)
 
void log (QString _message)
 
void getMenubarMenu (QString _name, QMenu *&_menu, bool _create)
 
void undo (int _objectid)
 
void undo ()
 
void redo (int _objectid)
 
void redo ()
 
void aboutToRestore (int _objectid)
 
void restored (int _objectid)
 
void generateBackup (int _id, QString _name, UpdateType _type)
 
void addToolbar (QToolBar *_toolbar)
 
void getToolBar (QString _name, QToolBar *&_toolbar)
 
void registerKey (int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse=false)
 
void addContextMenuItem (QAction *_action, DataType _objectType, ContextMenuType _type)
 
- Signals inherited from BaseInterface
virtual void updateView ()
 Update current view in Main Application. More...
 
virtual void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 Set a description for a public slot. More...
 
virtual void setRenderer (unsigned int _viewer, QString _rendererName)
 Set a renderer for the given viewer. More...
 
- Signals inherited from KeyInterface
virtual void registerKey (int _key, Qt::KeyboardModifiers _modifiers, QString _description, bool _multiUse=false)
 Register a key-combination for your plugin. More...
 
- Signals inherited from MenuInterface
virtual void getMenubarMenu (QString _name, QMenu *&_menu, bool _create)
 Get a existing top level menu pointer or create a new one. More...
 
- Signals inherited from BackupInterface
virtual void createBackup (int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
 Tell Backup Plugin to create a backup. More...
 
virtual void aboutToRestore (int _objectid)
 Backup Plugin tells other Plugins that a restore will happen. More...
 
virtual void generateBackup (int _id, QString _name, UpdateType _type)
 This signal is emitted by a BackupPlugin and tells a TypePlugin to generate a backup. More...
 
- Signals inherited from LoggingInterface
virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 
- Signals inherited from ToolbarInterface
virtual void addToolbar (QToolBar *_toolbar)
 Adds a Toolbar to the main widget. More...
 
- Signals inherited from LoadSaveInterface
virtual void save (int _id, QString _filename)
 Save object to a file. More...
 
virtual void load (QString _filename, DataType _type, int &_id)
 Load object from file with a specific DataType. More...
 
- Signals inherited from ContextMenuInterface
virtual void addContextMenuItem (QAction *_action, ContextMenuType _type)
 Add an entry for a context Menu. More...
 
- Signals inherited from PythonInterface
virtual void executePythonScript (QString _script)
 

Public Member Functions

void createBackup (int _objectId, const QString &_name, UpdateType _type=UPDATE_ALL)
 
QString name ()
 Return a name for the plugin. More...
 
QString description ()
 Return a description of what the plugin is doing. More...
 
void createBackupSimple (int _objectId, const QString &_name)
 

Private Slots

void initializePlugin ()
 
void pluginsInitialized ()
 
void slotAllCleared ()
 
void slotKeyEvent (QKeyEvent *_event)
 
void objectDeleted (int _objectid)
 
void slotCreateBackup (int _objectid, QString _name, UpdateType _type=UPDATE_ALL)
 
void slotCreateBackup (IdList _objectids, QString _name, std::vector< UpdateType > _types)
 
void slotUndo (int _objectid)
 
void slotRedo (int _objectid)
 
void slotUndo ()
 
void slotRedo ()
 
void slotUpdateContextMenu (int _objectId)
 
bool initializeOptionsWidget (QWidget *&_widget)
 
void applyOptions ()
 
void updateButtons ()
 
void slotEnableDisableBackups ()
 Backups enabled or disabled checkbox. More...
 
void slotObjectUndo ()
 
void slotObjectRedo ()
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 
- Private Slots inherited from KeyInterface
virtual void slotKeyEvent (QKeyEvent *_event)
 Key Event from Main App. More...
 

Private Attributes

GroupData globalBackup_
 
QMenu * backupMenu_
 The backup Menu. More...
 
QAction * backupsEnabledAction_
 
QAction * undoMenuAction_
 
QAction * redoMenuAction_
 
QAction * undoToolAction_
 
QAction * redoToolAction_
 
QAction * undoContextAction_
 
QAction * redoContextAction_
 
QSpinBox * maxBackupSpinBox_
 

Additional Inherited Members

- Private Member Functions inherited from BaseInterface
virtual void noguiSupported ()
 
virtual ~BaseInterface ()
 Destructor. More...
 
virtual void blockScenegraphUpdates (bool _block)
 Tell the core to prevent scenegraph updates. More...
 
virtual void updatedObject (int _objectId)
 An object has been changed or added by this plugin. More...
 
virtual void updatedObject (int _identifier, const UpdateType &_type)
 An object has been changed or added by this plugin. More...
 
virtual void nodeVisibilityChanged (int _identifier)
 A scenegraph node has been shown or hidden. More...
 
virtual void getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
 Get the current renderer for the given viewer. More...
 
- Private Member Functions inherited from KeyInterface
virtual void slotKeyReleaseEvent (QKeyEvent *_event)
 Key Release Event from Main App. More...
 
virtual ~KeyInterface ()
 Destructor. More...
 
- Private Member Functions inherited from MenuInterface
virtual ~MenuInterface ()
 Destructor. More...
 
virtual void addMenubarAction (QAction *_action, QString _name)
 Adds an action to the menubar. More...
 
virtual void addMenubarActions (std::vector< QAction * > &_actions, QString _name)
 Add multiple actions to the menu bar. More...
 
- Private Member Functions inherited from BackupInterface
virtual void createBackup (IdList _objectids, QString _name, std::vector< UpdateType > _types)
 Tell Backup Plugin to create a group backup. More...
 
virtual void undo (int _objectid)
 Tell Backup Plugin to undo the last action of an object. More...
 
virtual void redo (int _objectid)
 Tell Backup Plugin to redo the last action on an object. More...
 
virtual void undo ()
 Tell Backup Plugin to undo the last action. More...
 
virtual void redo ()
 Tell Backup Plugin to redo the last action. More...
 
virtual ~BackupInterface ()
 Destructor. More...
 
virtual void restored (int _objectid)
 Backup Plugin tells other Plugins that a restore has happened. More...
 
- Private Member Functions inherited from LoggingInterface
virtual ~LoggingInterface ()
 Destructor. More...
 
- Private Member Functions inherited from ToolbarInterface
virtual ~ToolbarInterface ()
 Destructor. More...
 
virtual void removeToolbar (QToolBar *_toolbar)
 Remove a Toolbar from the main widget. More...
 
virtual void getToolBar (QString _name, QToolBar *&_toolbar)
 Get a pointer to a Toolbar of the given name or 0 if it does not exist. More...
 
- Private Member Functions inherited from LoadSaveInterface
virtual ~LoadSaveInterface ()
 Destructor. More...
 
virtual void addEmptyObject (DataType _type, int &_id)
 
virtual void copyObject (int _oldId, int &_newId)
 
virtual void emptyObjectAdded (int _id)
 DEPRECATED HERE (Moved to Type Interface)! Emit this signal if an empty object has been created. More...
 
virtual void deleteObject (int _id)
 Delete an object
This signal can be called from any thread.
. More...
 
virtual void deleteAllObjects ()
 Delete all Objects. More...
 
virtual void getAllFileFilters (QStringList &_filters)
 Get all file filters that are registered. More...
 
- Private Member Functions inherited from ContextMenuInterface
virtual ~ContextMenuInterface ()
 Destructor. More...
 
virtual void addContextMenuItem (QAction *_action, DataType _objectType, ContextMenuType _type)
 Add an entry for a context Menu. More...
 
virtual void hideContextMenu ()
 hide the main context menu More...
 
- Private Member Functions inherited from OptionsInterface
virtual ~OptionsInterface ()
 Destructor. More...
 
virtual bool initializeOptionsWidget (QWidget *&_widget)=0
 Initialize the Options Widget. More...
 
virtual void applyOptions ()=0
 Apply changes to options. More...
 
- Private Member Functions inherited from PythonInterface
virtual void openPythonScriptInEditor (QString _script)
 
virtual ~PythonInterface ()
 Destructor. More...
 

Detailed Description

Definition at line 62 of file BackupPlugin.hh.

Constructor & Destructor Documentation

◆ ~BackupPlugin()

BackupPlugin::~BackupPlugin ( )
inline

Definition at line 156 of file BackupPlugin.hh.

◆ BackupPlugin()

BackupPlugin::BackupPlugin ( )

Definition at line 55 of file BackupPlugin.cc.

Member Function Documentation

◆ applyOptions

void BackupPlugin::applyOptions ( )
privateslot

Definition at line 461 of file BackupPlugin.cc.

◆ createBackup()

void BackupPlugin::createBackup ( int  _objectId,
const QString &  _name,
UpdateType  _type = UPDATE_ALL 
)

Definition at line 433 of file BackupPlugin.cc.

◆ createBackupSimple()

void BackupPlugin::createBackupSimple ( int  _objectId,
const QString &  _name 
)

Definition at line 468 of file BackupPlugin.cc.

◆ description()

QString BackupPlugin::description ( )
inlinevirtual

Return a description of what the plugin is doing.

This function has to return a basic description of the plugin

Implements BaseInterface.

Definition at line 160 of file BackupPlugin.hh.

◆ initializeOptionsWidget

bool BackupPlugin::initializeOptionsWidget ( QWidget *&  _widget)
privateslot

Definition at line 440 of file BackupPlugin.cc.

◆ initializePlugin

void BackupPlugin::initializePlugin ( )
privateslot

Definition at line 72 of file BackupPlugin.cc.

◆ name()

QString BackupPlugin::name ( )
inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 159 of file BackupPlugin.hh.

◆ objectDeleted

void BackupPlugin::objectDeleted ( int  _objectid)
privateslot

Definition at line 228 of file BackupPlugin.cc.

◆ pluginsInitialized

void BackupPlugin::pluginsInitialized ( )
privateslot

Definition at line 82 of file BackupPlugin.cc.

◆ slotAllCleared

void BackupPlugin::slotAllCleared ( )
privateslot

Definition at line 166 of file BackupPlugin.cc.

◆ slotCreateBackup [1/2]

void BackupPlugin::slotCreateBackup ( IdList  _objectids,
QString  _name,
std::vector< UpdateType _types 
)
privateslot

Definition at line 328 of file BackupPlugin.cc.

◆ slotCreateBackup [2/2]

void BackupPlugin::slotCreateBackup ( int  _objectid,
QString  _name,
UpdateType  _type = UPDATE_ALL 
)
privateslot

Definition at line 288 of file BackupPlugin.cc.

◆ slotEnableDisableBackups

void BackupPlugin::slotEnableDisableBackups ( )
privateslot

Backups enabled or disabled checkbox.

Definition at line 204 of file BackupPlugin.cc.

◆ slotKeyEvent

void BackupPlugin::slotKeyEvent ( QKeyEvent *  _event)
privateslot

Definition at line 212 of file BackupPlugin.cc.

◆ slotObjectRedo

void BackupPlugin::slotObjectRedo ( )
privateslot

Definition at line 280 of file BackupPlugin.cc.

◆ slotObjectUndo

void BackupPlugin::slotObjectUndo ( )
privateslot

Definition at line 272 of file BackupPlugin.cc.

◆ slotRedo [1/2]

void BackupPlugin::slotRedo ( )
privateslot

Definition at line 416 of file BackupPlugin.cc.

◆ slotRedo [2/2]

void BackupPlugin::slotRedo ( int  _objectid)
privateslot

Definition at line 404 of file BackupPlugin.cc.

◆ slotUndo [1/2]

void BackupPlugin::slotUndo ( )
privateslot

Definition at line 380 of file BackupPlugin.cc.

◆ slotUndo [2/2]

void BackupPlugin::slotUndo ( int  _objectid)
privateslot

Definition at line 368 of file BackupPlugin.cc.

◆ slotUpdateContextMenu

void BackupPlugin::slotUpdateContextMenu ( int  _objectId)
privateslot

Definition at line 235 of file BackupPlugin.cc.

◆ updateButtons

void BackupPlugin::updateButtons ( )
privateslot

Definition at line 173 of file BackupPlugin.cc.

◆ version

QString BackupPlugin::version ( )
inlineslot

Definition at line 151 of file BackupPlugin.hh.

Member Data Documentation

◆ backupMenu_

QMenu* BackupPlugin::backupMenu_
private

The backup Menu.

Definition at line 168 of file BackupPlugin.hh.

◆ backupsEnabledAction_

QAction* BackupPlugin::backupsEnabledAction_
private

Definition at line 170 of file BackupPlugin.hh.

◆ globalBackup_

GroupData BackupPlugin::globalBackup_
private

Definition at line 165 of file BackupPlugin.hh.

◆ maxBackupSpinBox_

QSpinBox* BackupPlugin::maxBackupSpinBox_
private

Definition at line 181 of file BackupPlugin.hh.

◆ redoContextAction_

QAction* BackupPlugin::redoContextAction_
private

Definition at line 179 of file BackupPlugin.hh.

◆ redoMenuAction_

QAction* BackupPlugin::redoMenuAction_
private

Definition at line 173 of file BackupPlugin.hh.

◆ redoToolAction_

QAction* BackupPlugin::redoToolAction_
private

Definition at line 176 of file BackupPlugin.hh.

◆ undoContextAction_

QAction* BackupPlugin::undoContextAction_
private

Definition at line 178 of file BackupPlugin.hh.

◆ undoMenuAction_

QAction* BackupPlugin::undoMenuAction_
private

Definition at line 172 of file BackupPlugin.hh.

◆ undoToolAction_

QAction* BackupPlugin::undoToolAction_
private

Definition at line 175 of file BackupPlugin.hh.


The documentation for this class was generated from the following files: