#include <gepetto/gui/settings.hh>

Collaboration diagram for gepetto::gui::Settings:

Public Member Functions
	Settings (const char *installDirectory)
	Set up default values. More...

void	setupPaths () const

QString	getQSettingsFileName (const std::string &settingsName) const
	Get the filename of a configuration file. More...

int	initSettings (int argc, char *argv[])

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 ()

void	saveState () const

void	restoreState () const

void	restoreDockWidgetsState () const

void	writeRobotFile ()

void	writeEnvFile ()

void	writeSettingFile ()

const char **	makeOmniORBargs (int &argc)

Public Attributes
std::string	configurationFile

std::string	predifinedRobotConf

std::string	predifinedEnvConf

std::string	stateConf

bool	verbose

bool	noPlugin

bool	autoWriteSettings

bool	useNameService

int	refreshRate

std::string	captureDirectory
	Path to avconv binary (maybe ffmpeg on some distributions). More...

std::string	captureFilename

std::string	captureExtension

QString	installDirectory

QString	appStyle

PluginManager	pluginManager_

QStringList	pluginsToInit_

QStringList	pyplugins_

QStringList	pyscripts_


QString	avconv

QStringList	avConvInputOptions

QStringList	avConvOutputOptions

Detailed Description

Settings manager for the interface.

This struct is responsible for parsing configuration files as follow:

Robots file: Settings::readRobotFile()
Environments file: Settings::readEnvFile()
Configuration file: Settings::readSettingFile()

Constructor & Destructor Documentation

◆ Settings()

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

Set up default values.

Member Function Documentation

◆ 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 ( )

◆ initSettings()

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

Initialize the settings. It uses the following elements, in this order:

read config file names from command line.
read config files.
read other command line arguments.
Returns
0 if no error,
1 if no error and the user requested to generate config files or to print the help,
2 in case of error.

◆ makeOmniORBargs()

const char** gepetto::gui::Settings::makeOmniORBargs ( int & argc )

◆ 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
; hppwidgetsplugin.so=true
; hppcorbaserverplugin.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.

◆ writeEnvFile()

void gepetto::gui::Settings::writeEnvFile ( )

◆ writeRobotFile()

void gepetto::gui::Settings::writeRobotFile ( )

◆ writeSettingFile()

void gepetto::gui::Settings::writeSettingFile ( )

◆ writeSettings()

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

Write the settings to configuration files.

Member Data Documentation

◆ appStyle

QString gepetto::gui::Settings::appStyle

◆ autoWriteSettings

bool gepetto::gui::Settings::autoWriteSettings

◆ avconv

QString gepetto::gui::Settings::avconv

record_parameter Video generation parameters

◆ avConvInputOptions

QStringList gepetto::gui::Settings::avConvInputOptions

◆ avConvOutputOptions

QStringList gepetto::gui::Settings::avConvOutputOptions

◆ captureDirectory

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

Path to avconv binary (maybe ffmpeg on some distributions).

◆ 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_

◆ pyscripts_

QStringList gepetto::gui::Settings::pyscripts_

◆ refreshRate

int gepetto::gui::Settings::refreshRate

◆ stateConf

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

◆ useNameService

bool gepetto::gui::Settings::useNameService

◆ verbose

bool gepetto::gui::Settings::verbose

The documentation for this struct was generated from the following file:

include/gepetto/gui/settings.hh

Public Member Functions

Public Attributes