ParameterSettable::StringDescriptor Class Reference

Utility Class for customize the description of String parameter. More...

Public Member Functions
	StringDescriptor (QString paramPath)
	Add (if not exists) the description of a String parameter.
StringDescriptor &	def (QString defaultValue)
	set the default value when the parameter is not present into the configuration
StringDescriptor &	help (QString shortHelp, QString longHelp=QString(""))
	Add a short help comment and a complete help comment.
StringDescriptor &	props (Properties properties)
	set the Properties of this parameter (see Property documentation)
template<class T >
StringDescriptor &	runtime (void(T::*setter)(QString), QString(T::*getter)() const )
	set the runtime accessors for this parameter

Detailed Description

Utility Class for customize the description of String parameter.

Definition at line 223 of file parametersettable.h.

Constructor & Destructor Documentation

StringDescriptor

(

QString

paramPath

)

Add (if not exists) the description of a String parameter.

Warning

Don't call it directly; use Descriptor::describeString instead

Definition at line 145 of file parametersettable.cpp.

References ConfigurationParameters::createGroup(), ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

Member Function Documentation

ParameterSettable::StringDescriptor & def

(

QString

defaultValue

)

set the default value when the parameter is not present into the configuration

Definition at line 152 of file parametersettable.cpp.

References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

ParameterSettable::StringDescriptor & help	(	QString	shortHelp,
		QString	longHelp = QString("")
	)

Add a short help comment and a complete help comment.

The short help comment is typically used as a tooltip help, while the complete help comment will be shown in the help section for the type

Parameters

shortHelp	is the short comment (rich text here is not allowed)
longHelp	is the long help (rich text here is allowed); if not specified the longHelp will be the same of the shortHelp

Definition at line 162 of file parametersettable.cpp.

References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

ParameterSettable::StringDescriptor & props

(

Properties

properties

)

set the Properties of this parameter (see Property documentation)

Definition at line 157 of file parametersettable.cpp.

References Factory::getTypeDescriptions().

StringDescriptor& runtime ( void(T::*)(QString)  setter, QString(T::*)() const  getter  )

inline

set the runtime accessors for this parameter

When a parameter is marked as runtime, it means that the value of the parameter can be changed in any moment using the setRuntimeParameter method bypassing the configure method.

Parameters

setter	is the pointer-to-member to the method used for setting the value of the parameter; it must accept one QString argument and return void
getter	is the pointer-to-member to the method used for getting the value of the parameter; it must accept no arguments and return QString

Definition at line 243 of file parametersettable.h.

---

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

• configuration/include/parametersettable.h
• configuration/src/parametersettable.cpp