ImFusion SDK 4.3
ActiveEnvironmentControl Class Reference

#include <ImFusion/Python/PythonSettings.h>

A QComboBox with additional add and remove button to change the entries. More...

+ Inheritance diagram for ActiveEnvironmentControl:

Detailed Description

A QComboBox with additional add and remove button to change the entries.

Used to configure the "environments" settings.

Public Member Functions

 ActiveEnvironmentControl (const std::string &n)
 
void updateValue (const std::string &value, const std::vector< Properties::Attribute > &attributes) override
 Updates the current value and adjusts the attributes.
 
void retrieveValue (Properties *p) const override
 Retrieves the value from the widget and writes it into the properties.
 
QWidget * widget () const override
 Returns the widget for this control.
 
void configure (const Properties *p) override
 Configure this object instance by de-serializing the given Properties.
 
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
 
void setEnvironments (std::vector< std::string > env)
 
const std::vector< std::string > & environments () const
 
void setActiveEnvironment (const std::string &env)
 
std::string activeEnvironment () const
 
- Public Member Functions inherited from ParamControl
 ParamControl (Properties::ParamType t, const std::string &n)
 Each control can only be used for a fixed type and parameter.
 
 ~ParamControl () override=default
 Subclasses are expected to delete their widget.
 
- Public Member Functions inherited from Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
 
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
 
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 
 Configurable (const Configurable &rhs)
 
 Configurable (Configurable &&rhs) noexcept
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Public Attributes

Signal< std::stringsignalValueChanged
 
- Public Attributes inherited from ParamControl
const Properties::ParamType type
 
const std::string name
 
std::vector< Properties::Attributeattributes
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 

Additional Inherited Members

- Signals inherited from ParamControl
void valueChanged ()
 Emitted when the parameter value was changed by the user.
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ updateValue()

void updateValue ( const std::string & value,
const std::vector< Properties::Attribute > & attributes )
overridevirtual

Updates the current value and adjusts the attributes.

Implements ParamControl.

◆ retrieveValue()

void retrieveValue ( Properties * p) const
overridevirtual

Retrieves the value from the widget and writes it into the properties.

Implements ParamControl.

◆ widget()

QWidget * widget ( ) const
overridevirtual

Returns the widget for this control.

The ParamControl does not own this widget, e.g. it must be re-parented to some other QWidget or deleted manually.

Implements ParamControl.

◆ configure()

void configure ( const Properties * p)
overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configuration() for the inverse functionality

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configure() for the inverse functionality

Reimplemented from Configurable.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close