Cube GUI Plugin User Guide  (CubeGUI 4.8.2, revision 7895e762)
How to develop a Cube GUI Plugin, road map and examples
Public Member Functions | List of all members
cubepluginapi::CubePlugin Class Referenceabstract

The CubePlugin class is base class of all plugins that depend on a loaded cube file.

#include <CubePlugin.h>

Inheritance diagram for cubepluginapi::CubePlugin:
cubepluginapi::PluginInterface

Public Member Functions

virtual bool cubeOpened (cubepluginapi::PluginServices *service)=0
 cubeOpened is called after a cube file has been loaded. It should return false, if the plugin should not be started with current data. More...
 
virtual void cubeClosed ()
 cubeClosed is called after the cube file has been closed. If resources have been allocated, they should be freed here. More...
 
virtual void version (int &major, int &minor, int &bugfix) const =0
 
virtual QString name () const =0
 returns the unique plugin name. Only one plugin with this name will beloaded. More...
 
virtual QString getHelpText () const =0
 returns a short text to describe the plugin. It will be used by help->plugin info menu of the Cube GUI. More...
 
virtual QString getHelpURL () const
 returns path to the html documentation. If path starts with http://, https:// or file:/ the path is handled as absolute path. Otherwise it is a relative path and refers to the Cube User Guide. The URL will be used by the help->plugins menu of the Cube GUI. More...
 
virtual QString getDeactivationMessage ()
 returns the reason why the plugin decided to deactivate itsself in cubeOpened More...
 
- Public Member Functions inherited from cubepluginapi::PluginInterface
QString versionLabel ()
 
virtual ~PluginInterface ()
 

Member Function Documentation

virtual void cubepluginapi::CubePlugin::cubeClosed ( )
virtual
virtual bool cubepluginapi::CubePlugin::cubeOpened ( cubepluginapi::PluginServices service)
pure virtual
virtual QString cubepluginapi::CubePlugin::getDeactivationMessage ( )
virtual
virtual QString cubepluginapi::CubePlugin::getHelpText ( ) const
pure virtual
virtual QString cubepluginapi::CubePlugin::getHelpURL ( ) const
virtual
virtual QString cubepluginapi::CubePlugin::name ( ) const
pure virtual
virtual void cubepluginapi::CubePlugin::version ( int &  major,
int &  minor,
int &  bugfix 
) const
pure virtual

Cube Writer Library    Copyright © 1998–2022 Forschungszentrum Jülich GmbH, Jülich Supercomputing Centre
Copyright © 2009–2015 German Research School for Simulation Sciences GmbH, Laboratory for Parallel Programming