A Setting with a floating point value. More...

#include <FloatSetting.hh>

Inheritance diagram for openmsx::FloatSetting:

[legend]

Collaboration diagram for openmsx::FloatSetting:

[legend]

Public Member Functions
	FloatSetting (CommandController &commandController, std::string_view name, static_string_view description, double initialValue, double minValue, double maxValue, Save save=Save::YES)

std::string_view	getTypeString () const override
	Returns a string describing the setting type (integer, string, ..) Could be used in a GUI to pick an appropriate setting widget.

void	additionalInfo (TclObject &result) const override
	Helper method for info().

double	getDouble () const noexcept

float	getFloat () const noexcept

void	setDouble (double d)

void	setFloat (float f)

double	getMinValue () const

double	getMaxValue () const

Public Member Functions inherited from openmsx::Setting
	Setting (const Setting &)=delete

	Setting (Setting &&)=delete

Setting &	operator= (const Setting &)=delete

Setting &	operator= (Setting &&)=delete

virtual	~Setting ()

const TclObject &	getValue () const final
	Gets the current value of this setting as a TclObject.

std::optional< TclObject >	getOptionalValue () const final
	Like getValue(), but in case of error returns an empty optional instead of throwing an exception.

void	setChecker (std::function< void(TclObject &)> checkFunc_)
	Set value-check-callback.

void	setValue (const TclObject &newValue) final
	Change the value of this setting to the given value.

std::string_view	getDescription () const final
	pure virtual methods ///

TclObject	getDefaultValue () const final
	Get the default value of this setting.

void	setValueDirect (const TclObject &newValue) final
	Similar to setValue(), but doesn't trigger Tcl traces.

void	tabCompletion (std::vector< std::string > &tokens) const override
	Complete a partly typed value.

bool	needLoadSave () const final
	Does this setting need to be loaded or saved (settings.xml).

void	additionalInfo (TclObject &result) const override
	Helper method for info().

bool	needTransfer () const final
	Does this setting need to be transfered on reverse.

CommandController &	getCommandController () const

Interpreter &	getInterpreter () const

Public Member Functions inherited from openmsx::BaseSetting
const TclObject &	getFullNameObj () const
	Get the name of this setting.

const TclObject &	getBaseNameObj () const

std::string_view	getFullName () const

std::string_view	getBaseName () const

void	setPrefix (std::string_view prefix)
	Set a machine specific prefix.

void	info (TclObject &result) const
	For SettingInfo.

Public Member Functions inherited from openmsx::Subject< Setting >
	Subject (const Subject &)=delete

	Subject (Subject &&)=delete

Subject &	operator= (const Subject &)=delete

Subject &	operator= (Subject &&)=delete

void	attach (Observer< Setting > &observer)

void	detach (Observer< Setting > &observer)

bool	anyObservers () const

Additional Inherited Members
Public Types inherited from openmsx::Setting
enum class	Save { YES , NO , NO_AND_DONT_TRANSFER }

Protected Member Functions inherited from openmsx::Setting
	Setting (CommandController &commandController, std::string_view name, static_string_view description, const TclObject &initialValue, Save save=Save::YES)

void	init ()

void	notifyPropertyChange () const

Protected Member Functions inherited from openmsx::BaseSetting
	BaseSetting (std::string_view name)

	BaseSetting (TclObject name)

	~BaseSetting ()=default

Protected Member Functions inherited from openmsx::Subject< Setting >
	Subject ()=default

	~Subject ()

void	notify () const

Detailed Description

A Setting with a floating point value.

Definition at line 10 of file FloatSetting.hh.

Constructor & Destructor Documentation

◆ FloatSetting()

openmsx::FloatSetting::FloatSetting	(	CommandController &	commandController,
		std::string_view	name,
		static_string_view	description,
		double	initialValue,
		double	minValue,
		double	maxValue,
		Save	save = `Save::YES`
	)