Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MantidQt::MantidWidgets::Configurable< Settings > Class Template Referenceabstract

Defines the in-memory half of the persistent settings lifecycle. More...

#include <Configurable.h>

Public Member Functions

virtual Settings captureSettings () const =0
 Capture current in-memory state without persistent I/O.
 
virtual void restoreSettings (const Settings &)=0
 Apply an already-read snapshot without persistent I/O.
 
virtual ~Configurable ()=default
 

Detailed Description

template<typename Settings>
class MantidQt::MantidWidgets::Configurable< Settings >

Defines the in-memory half of the persistent settings lifecycle.

Persistent read and save operations belong to the concrete Settings type.

Definition at line 46 of file Configurable.h.

Constructor & Destructor Documentation

◆ ~Configurable()

template<typename Settings >
virtual MantidQt::MantidWidgets::Configurable< Settings >::~Configurable ( )
virtualdefault

Member Function Documentation

◆ captureSettings()

template<typename Settings >
virtual Settings MantidQt::MantidWidgets::Configurable< Settings >::captureSettings ( ) const
pure virtual

Capture current in-memory state without persistent I/O.

Implemented in MantidQt::API::AbstractAlgorithmInputHistory, and MantidQt::MantidWidgets::MessageDisplay.

◆ restoreSettings()

template<typename Settings >
virtual void MantidQt::MantidWidgets::Configurable< Settings >::restoreSettings ( const Settings &  )
pure virtual

Apply an already-read snapshot without persistent I/O.

Implemented in MantidQt::MantidWidgets::MessageDisplay.


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