PropertiesListWidget Class Reference

#include <ImFusion/GUI/PropertiesListWidget.h>

The PropertiesListWidget shows as sub-properties as a list. More...

Inheritance diagram for PropertiesListWidget:

Detailed Description

The PropertiesListWidget shows as sub-properties as a list.

All sub-properties of a Properties object are treated as items of the list and are expected to have the same parameter structure. List items can be removed and edited. New list items can be added. Further sub-properties of the sub-properties are not represented by further PropertiesListWidgets.

Public Slots
void	addItem ()
void	removeItem (QListWidgetItem *item)
void	editItem (QListWidgetItem *item)

Public Member Functions
	PropertiesListWidget (const Properties *p=nullptr, QWidget *parent=nullptr)
void	setAddTemplate (const Properties &p)
	Sets a template that is used when adding a new item.
void	setForceTemplateParamType (bool enable)
	If enabled, each params type and type attribute is overridden with the corresponding value from the template (if available).
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.
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
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

setAddTemplate()

void setAddTemplate

(

const Properties &

p

)

Sets a template that is used when adding a new item.

If the template is empty (the default), adding new items is not possible.

setForceTemplateParamType()

void setForceTemplateParamType

(

bool

enable

)

If enabled, each params type and type attribute is overridden with the corresponding value from the template (if available).

Default is disabled.

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:

• ImFusion/GUI/PropertiesListWidget.h