SettingsDialog::CustomSettingsWidget Class Reference

#include <ImFusion/GUI/SettingsDialog.h>

Base class for custom settings widgets. More...

Inheritance diagram for SettingsDialog::CustomSettingsWidget:

Detailed Description

Base class for custom settings widgets.

Public Member Functions
virtual bool	updateWidget ()
	Update the widget in the Settings Dialog.
Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
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
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Additional Inherited Members
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

updateWidget()

virtual bool updateWidget ( )

inlinevirtual

Update the widget in the Settings Dialog.

By default the settings fields of the custom settings will not change after they were registered with SettingsDialog. However if you need to update the fields of your settings widget by adding or removing sub-properties and parameters, have this function return true to indicate that.

Reimplemented in SettingsWidget, and SettingsWidget.

---

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

• ImFusion/GUI/SettingsDialog.h