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

#include <SettingsHandler.h>

Public Member Functions

virtual void loadGlobalSettings (QSettings &)
 
virtual void saveGlobalSettings (QSettings &)
 
virtual void loadExperimentSettings (QSettings &)
 
virtual void saveExperimentSettings (QSettings &)
 
virtual void loadGlobalOnlySettings (QSettings &)
 
virtual void saveGlobalOnlySettings (QSettings &)
 
virtual void loadStatus (QSettings &)
 
virtual void saveStatus (QSettings &)
 
virtual bool synchronizationIsDefault ()
 
virtual QString settingName ()=0
 
QString settingNameCompact ()
 

Detailed Description

SettingsHandler provides methods which are called, if the settings are loaded or saved

See also
PluginServices::addSettingsHandler
examples/GUI/plugins/plugin-demo

Member Function Documentation

virtual void cubepluginapi::SettingsHandler::loadExperimentSettings ( QSettings &  )
virtual

these settings contain experiment specific options, that can only be applied if an experiment is loaded

virtual void cubepluginapi::SettingsHandler::loadGlobalOnlySettings ( QSettings &  )
virtual

these settings are only saved for global scope. Use these methods only, if experiment specific settings are not wanted

virtual void cubepluginapi::SettingsHandler::loadGlobalSettings ( QSettings &  )
virtual

these settings are only saved for global and experiment specific scope

virtual void cubepluginapi::SettingsHandler::loadStatus ( QSettings &  )
virtual

Used to synchronize status of several cube instances,

See also
ClipboardToolBar.
virtual void cubepluginapi::SettingsHandler::saveExperimentSettings ( QSettings &  )
virtual
virtual void cubepluginapi::SettingsHandler::saveGlobalOnlySettings ( QSettings &  )
virtual
virtual void cubepluginapi::SettingsHandler::saveGlobalSettings ( QSettings &  )
virtual
virtual void cubepluginapi::SettingsHandler::saveStatus ( QSettings &  )
virtual
virtual QString cubepluginapi::SettingsHandler::settingName ( )
pure virtual
QString cubepluginapi::SettingsHandler::settingNameCompact ( )
virtual bool cubepluginapi::SettingsHandler::synchronizationIsDefault ( )
virtual

synchronizationIsDefault returns true, if the synchronization should be enabled without manual selection


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