Dev implementation of the config interface. More...

#include <config_impl_dev.h>

Inheritance diagram for ConfigImplDev< T >:

Collaboration diagram for ConfigImplDev< T >:

Public Member Functions
template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< int >::type &default_value, int min, int max, bool restart_when_changed)

template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< double >::type &default_value, double min, double max, bool restart_when_changed)

template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< std::string >::type &default_value, std::function< bool(std::string &)> checker, bool restart_when_changed)

template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< std::list< std::string > >::type &default_value, const std::list< std::string > &possibilities, bool restart_when_changed)

template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< bool >::type &default_value, bool restart_when_changed)

template<>
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< FilePath >::type &default_value, FilePath::Mode file_mode, const std::string &filter, bool restart_when_changed)

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

template<>
void	load (void)
	Load the value of this config from the settings scope. More...

Config interface implementation
These are the same parameters that are used in RovizItem. See also RovizItem
	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, int min, int max, bool restart_when_changed)

	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, double min, double max, bool restart_when_changed)

	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, std::function< bool(std::string &)> checker, bool restart_when_changed)

	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, const std::list< std::string > &possibilities, bool restart_when_changed)

	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, bool restart_when_changed)

	ConfigImplDev (RovizItemBaseDev *parent, const std::string &name, const typename ConfigStorageType< T >::type &default_value, enum FilePath::Mode file_mode, const std::string &filter, bool restart_when_changed)

QWidget *	widget (void) const override
	} More...

void	load (void)
	Load the value of this config from the settings scope. More...

bool	changed (void) override
	Called, when the config changes are applied.

void	refresh (void) override
	Notify the item that the config value changed. More...

void	lock (void) override
	Lock the mutex of the config. More...

void	unlock (void) override
	Unlock the mutex of the config. More...

void *	value (void) override
	Get the value of the config. More...

Detailed Description

template<typename T>
class ConfigImplDev< T >

Dev implementation of the config interface.

Implements the saving of configs using the itemframeworks settings scope.

See also: Config; ConfigImpl; ConfigImplDevBase

Member Function Documentation

◆ load() [1/7]

template<typename T>

void ConfigImplDev< T >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplBaseDev::load

Implements ConfigImplBaseDev.

◆ load() [2/7]

template<>

void ConfigImplDev< int >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ load() [3/7]

template<>

void ConfigImplDev< double >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ load() [4/7]

template<>

void ConfigImplDev< std::string >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ load() [5/7]

template<>

void ConfigImplDev< std::list< std::string > >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ load() [6/7]

template<>

void ConfigImplDev< bool >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ load() [7/7]

template<>

void ConfigImplDev< FilePath >::load ( void )

virtual

Load the value of this config from the settings scope.

Note: It can't be loaded in the constructor becuaes the settings scope is not valid yet at that time.

See also: ConfigImplDev::load

Implements ConfigImplBaseDev.

Here is the call graph for this function:

◆ lock()

template<typename T >

void ConfigImplDev< T >::lock ( void )

overridevirtual

Lock the mutex of the config.

See also: ConfigImpl::lock; unlock

Implements ConfigImpl.

◆ refresh()

template<typename T >

void ConfigImplDev< T >::refresh ( void )

overridevirtual

Notify the item that the config value changed.

This notifies the config that the user changed the config and that those changes should be propagated to the plugin.

See also: ConfigImplBaseDev::refresh

Implements ConfigImplBaseDev.

◆ unlock()

template<typename T >

void ConfigImplDev< T >::unlock ( void )

overridevirtual

Unlock the mutex of the config.

See also: ConfigImpl::unlock; lock

Implements ConfigImpl.

◆ value()

template<typename T >

void * ConfigImplDev< T >::value ( void )

overridevirtual

Get the value of the config.

Returns: A pointer to the value

See also: ConfigImpl::value

Implements ConfigImpl.

Here is the call graph for this function:

◆ widget()

template<typename T >

QWidget * ConfigImplDev< T >::widget ( void ) const

overridevirtual

}

Returns: The QWidget associated with this config

Every config has a widget that is used to adjust the value. This function returns the widget for this config.

Implements ConfigImplBaseDev.

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

usercore/include/backend_dev/config_impl_dev.h
usercore/src/backend_dev/config_impl_dev.cpp

Public Member Functions

Config interface implementation

Detailed Description

template<typename T> class ConfigImplDev< T >

Member Function Documentation

◆ load() [1/7]

◆ load() [2/7]

◆ load() [3/7]

◆ load() [4/7]

◆ load() [5/7]

◆ load() [6/7]

◆ load() [7/7]

◆ lock()

◆ refresh()

◆ unlock()

◆ value()

◆ widget()

template<typename T>
class ConfigImplDev< T >