Mantid::Kernel::IPropertySettings Class Reference

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 bool	applyChanges (const IPropertyManager *algo, const std::string &currentPropName)
	Overload this virtual function in order to modify the current property based on changes to other properties.
virtual IPropertySettings *	clone () const =0
	Make a copy of the present type of IPropertySettings.
virtual std::vector< std::string >	dependsOn (const std::string &) const
	Other properties that this property depends on.
	IPropertySettings ()=default
	Constructor.
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
virtual bool	isEnabled (const IPropertyManager *algo) const
	Is the property to be shown as "enabled" in the GUI.
virtual bool	isVisible (const IPropertyManager *algo) const
	Is the property to be shown in the GUI? Default true.
virtual	~IPropertySettings ()=default
	Destructor.

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 28 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 bool Mantid::Kernel::IPropertySettings::applyChanges ( const IPropertyManager *  algo, const std::string &  currentPropName  )

inlinevirtual

Overload this virtual function in order to modify the current property based on changes to other properties.

Returns

: whether or not the current property was changed.

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

Definition at line 61 of file IPropertySettings.h.

References UNUSED_ARG.

Referenced by export_IPropertySettings(), and MantidQt::API::AlgorithmPropertiesWidget::hideOrDisableProperties().

clone()

virtual IPropertySettings * Mantid::Kernel::IPropertySettings::clone ( ) const

pure virtual

Make a copy of the present type of IPropertySettings.

Implemented in Mantid::Algorithms::MonIDPropChanger, Mantid::API::EnabledWhenWorkspaceIsType< T >, Mantid::Crystal::OrEnabledWhenProperties, Mantid::Kernel::EnabledWhenProperty, Mantid::Kernel::InvisibleProperty, Mantid::Kernel::SetDefaultWhenProperty, Mantid::Kernel::SetValueWhenProperty, and Mantid::Kernel::VisibleWhenProperty.

dependsOn()

virtual std::vector< std::string > Mantid::Kernel::IPropertySettings::dependsOn ( const std::string &  ) const

inlinevirtual

Other properties that this property depends on.

Reimplemented in Mantid::API::EnabledWhenWorkspaceIsType< T >, Mantid::Kernel::EnabledWhenProperty, Mantid::Kernel::SetDefaultWhenProperty, Mantid::Kernel::SetValueWhenProperty, and Mantid::Kernel::VisibleWhenProperty.

Definition at line 68 of file IPropertySettings.h.

Referenced by export_IPropertySettings().

isConditionChanged()

virtual bool Mantid::Kernel::IPropertySettings::isConditionChanged ( const IPropertyManager *  algo, const std::string &  changedPropName = ""  ) const

inlinevirtual

to verify if the properties, this one depends on have changed or other special condition occurs which needs the framework to react to

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

Definition at line 50 of file IPropertySettings.h.

References UNUSED_ARG.

Referenced by export_IPropertySettings(), and MantidQt::API::AlgorithmPropertiesWidget::hideOrDisableProperties().

isEnabled()

virtual bool Mantid::Kernel::IPropertySettings::isEnabled ( const IPropertyManager *  algo ) const

inlinevirtual

Is the property to be shown as "enabled" in the GUI.

Default true.

Reimplemented in Mantid::Crystal::OrEnabledWhenProperties, Mantid::Kernel::EnabledWhenProperty, Mantid::Kernel::VisibleWhenProperty, Mantid::API::EnabledWhenWorkspaceIsType< T >, and Mantid::Algorithms::MonIDPropChanger.

Definition at line 37 of file IPropertySettings.h.

References UNUSED_ARG.

Referenced by Mantid::Kernel::PropertyManager::asJson(), and export_IPropertySettings().

isVisible()

virtual bool Mantid::Kernel::IPropertySettings::isVisible ( const IPropertyManager *  algo ) const

inlinevirtual

Is the property to be shown in the GUI? Default true.

Reimplemented in Mantid::Kernel::InvisibleProperty, Mantid::Kernel::EnabledWhenProperty, Mantid::Kernel::VisibleWhenProperty, and Mantid::API::EnabledWhenWorkspaceIsType< T >.

Definition at line 43 of file IPropertySettings.h.

References UNUSED_ARG.

Referenced by export_IPropertySettings(), and MantidQt::API::AlgorithmPropertiesWidget::hideOrDisableProperties().

---

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

• Framework/Kernel/inc/MantidKernel/IPropertySettings.h