Interface for modifiers to Property's that specify if they should be enabled or visible in a GUI. More...

#include <IPropertySettings.h>

Inheritance diagram for Mantid::Kernel::IPropertySettings:

Public Member Functions
virtual void	applyChanges (const IPropertyManager , Property const)
	The function user have to overload it in their custom code to modify the property according to the changes to other properties. More...

virtual IPropertySettings *	clone () const =0
	Make a copy of the present type of IPropertySettings. More...

	IPropertySettings ()=default
	Constructor. More...

virtual bool	isConditionChanged (const IPropertyManager *algo, const std::string &changedPropName="") const
	to verify if the properties, this one depends on have changed or other special condition occurs which needs the framework to react to More...

virtual bool	isEnabled (const IPropertyManager *algo) const
	Is the property to be shown as "enabled" in the GUI. More...

virtual bool	isVisible (const IPropertyManager *algo) const
	Is the property to be shown in the GUI? Default true. More...

virtual	~IPropertySettings ()=default
	Destructor. More...

Protected Member Functions
	IPropertySettings (const IPropertySettings &)=default

Detailed Description

Interface for modifiers to Property's that specify if they should be enabled or visible in a GUI.

They are set on an algorithm via Algorithm::setPropertySettings()

Author: Janik Zikovsky

Date: 2011-08-26

Definition at line 27 of file IPropertySettings.h.

Constructor & Destructor Documentation

◆ IPropertySettings() [1/2]

Mantid::Kernel::IPropertySettings::IPropertySettings ( )

default

Constructor.

◆ ~IPropertySettings()

virtual Mantid::Kernel::IPropertySettings::~IPropertySettings ( )

virtualdefault

Destructor.

◆ IPropertySettings() [2/2]

Mantid::Kernel::IPropertySettings::IPropertySettings ( const IPropertySettings & )

protecteddefault

Member Function Documentation

◆ applyChanges()

virtual void Mantid::Kernel::IPropertySettings::applyChanges	(	const IPropertyManager *	,
		Property * const
	)

inlinevirtual

The function user have to overload it in their custom code to modify the property according to the changes to other properties.

Currently it has been tested to modify the property values as function of other properties

Allowed property values are obtained from property's allowedValues function, and the purpose the function interfaced here is to modify its output.

allowedValues function on propertyWithValue class obtains its data from a validator, so in the case of simple PropertyWithValue, this function has to replace the validator. For WorkspaceProperty, which obtains its values from dataservice and filters them by validators, a new validator has to be a new filter

Reimplemented in Mantid::Algorithms::MonIDPropChanger, and Mantid::Kernel::SetValueWhenProperty.

Definition at line 71 of file IPropertySettings.h.

Referenced by MantidQt::API::AlgorithmPropertiesWidget::hideOrDisableProperties().