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

Defines an interface for an object to load and store any configuration settings that should persist between objects. More...

#include <Configurable.h>

Inheritance diagram for MantidQt::MantidWidgets::Configurable:
MantidQt::API::AbstractAlgorithmInputHistory MantidQt::MantidWidgets::MessageDisplay MantidQt::API::AlgorithmInputHistoryImpl

Public Member Functions

virtual void readSettings (const QSettings &)=0
 
virtual void writeSettings (QSettings &) const =0
 
virtual ~Configurable ()=default
 

Detailed Description

Defines an interface for an object to load and store any configuration settings that should persist between objects.

A widget should inherit from this class and define the loadSettings and saveSettings member functions. These functions are expected to be called by the client along with a QSettings instance, opened at the correct group, which will either give access or receive the values.

Definition at line 24 of file Configurable.h.

Constructor & Destructor Documentation

◆ ~Configurable()

virtual MantidQt::MantidWidgets::Configurable::~Configurable ( )
virtualdefault

Member Function Documentation

◆ readSettings()

virtual void MantidQt::MantidWidgets::Configurable::readSettings ( const QSettings &  )
pure virtual

◆ writeSettings()

virtual void MantidQt::MantidWidgets::Configurable::writeSettings ( QSettings &  ) const
pure virtual

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