Public Member Functions | Public Attributes | List of all members
gepetto::gui::Settings Struct Reference

Settings manager for the interface. More...

#include <gepetto/gui/settings.hh>

Collaboration diagram for gepetto::gui::Settings:
[legend]

Public Member Functions

 Settings (const char *installDirectory)
 Set up default values. More...
 
void setupPaths () const
 Setup paths to find setting files and plugins. More...
 
QString getQSettingsFileName (const std::string &settingsName) const
 Get the filename of a configuration file. More...
 
int fromArgv (int argc, char *argv[])
 Update values accordingly with command arguments. More...
 
void fromFiles ()
 Update settings from setting files. More...
 
void writeSettings ()
 Write the settings to configuration files. More...
 
QVariant getSetting (const QString &key, const QVariant &defaultValue=QVariant())
 Get a setting. More...
 
void setMainWindow (MainWindow *main)
 
void initPlugins ()
 
std::ostream & print (std::ostream &os)
 
void readRobotFile ()
 
void readEnvFile ()
 
void readSettingFile ()
 Read the settings file. More...
 
void saveState () const
 
void restoreState () const
 
void restoreDockWidgetsState () const
 

Public Attributes

std::string configurationFile
 
std::string predifinedRobotConf
 
std::string predifinedEnvConf
 
std::string stateConf
 
bool verbose
 
bool noPlugin
 
bool autoWriteSettings
 
bool startGepettoCorbaServer
 
int refreshRate
 
std::string captureDirectory
 
std::string captureFilename
 
std::string captureExtension
 
QString installDirectory
 
PluginManager pluginManager_
 
QStringList pluginsToInit_
 
QStringList pyplugins_
 

Detailed Description

Settings manager for the interface.

This struct is responsible for parsing configuration files as follow:

Constructor & Destructor Documentation

◆ Settings()

gepetto::gui::Settings::Settings ( const char *  installDirectory)

Set up default values.

Member Function Documentation

◆ fromArgv()

int gepetto::gui::Settings::fromArgv ( int  argc,
char *  argv[] 
)

Update values accordingly with command arguments.

◆ fromFiles()

void gepetto::gui::Settings::fromFiles ( )

Update settings from setting files.

◆ getQSettingsFileName()

QString gepetto::gui::Settings::getQSettingsFileName ( const std::string &  settingsName) const

Get the filename of a configuration file.

◆ getSetting()

QVariant gepetto::gui::Settings::getSetting ( const QString &  key,
const QVariant &  defaultValue = QVariant() 
)

Get a setting.

◆ initPlugins()

void gepetto::gui::Settings::initPlugins ( )

◆ print()

std::ostream& gepetto::gui::Settings::print ( std::ostream &  os)

◆ readEnvFile()

void gepetto::gui::Settings::readEnvFile ( )
Note
Prefer using Settings::fromFiles()

◆ readRobotFile()

void gepetto::gui::Settings::readRobotFile ( )
Note
Prefer using Settings::fromFiles()

◆ readSettingFile()

void gepetto::gui::Settings::readSettingFile ( )

Read the settings file.

Here is the syntax:

; Comments starts with a ; You may uncomment to see the effect.
[plugins]
; Put a list of C++ plugins followed by '=true'. For instance, HPP users may have
; libhppwidgetsplugin.so=true
; libhppcorbaserverplugin.so=true
[pyplugins]
; Put a list of Python plugins followed by '=true'. For instance, the example plugin can be loaded with
; gepetto.plugin=true
; WARNING: Any comment in this file may be removed by the GUI if you regenerate a configuration file.
Note
Details on plugin interface can be found in PluginInterface, resp. PythonWidget, class for C++, resp. Python, plugins.
Prefer using Settings::fromFiles()

◆ restoreDockWidgetsState()

void gepetto::gui::Settings::restoreDockWidgetsState ( ) const

◆ restoreState()

void gepetto::gui::Settings::restoreState ( ) const

◆ saveState()

void gepetto::gui::Settings::saveState ( ) const

◆ setMainWindow()

void gepetto::gui::Settings::setMainWindow ( MainWindow main)

◆ setupPaths()

void gepetto::gui::Settings::setupPaths ( ) const

Setup paths to find setting files and plugins.

Note
The environment variable GEPETTO_GUI_PLUGIN_DIRS, LD_LIBRARY_PATH and GEPETTO_GUI_SETTINGS_DIR are read.

◆ writeSettings()

void gepetto::gui::Settings::writeSettings ( )

Write the settings to configuration files.

Member Data Documentation

◆ autoWriteSettings

bool gepetto::gui::Settings::autoWriteSettings

◆ captureDirectory

std::string gepetto::gui::Settings::captureDirectory

◆ captureExtension

std::string gepetto::gui::Settings::captureExtension

◆ captureFilename

std::string gepetto::gui::Settings::captureFilename

◆ configurationFile

std::string gepetto::gui::Settings::configurationFile

◆ installDirectory

QString gepetto::gui::Settings::installDirectory

◆ noPlugin

bool gepetto::gui::Settings::noPlugin

◆ pluginManager_

PluginManager gepetto::gui::Settings::pluginManager_

◆ pluginsToInit_

QStringList gepetto::gui::Settings::pluginsToInit_

◆ predifinedEnvConf

std::string gepetto::gui::Settings::predifinedEnvConf

◆ predifinedRobotConf

std::string gepetto::gui::Settings::predifinedRobotConf

◆ pyplugins_

QStringList gepetto::gui::Settings::pyplugins_

◆ refreshRate

int gepetto::gui::Settings::refreshRate

◆ startGepettoCorbaServer

bool gepetto::gui::Settings::startGepettoCorbaServer

◆ stateConf

std::string gepetto::gui::Settings::stateConf

◆ verbose

bool gepetto::gui::Settings::verbose