A Setting with an integer value. More...

#include <IntegerSetting.hh>

Inheritance diagram for openmsx::IntegerSetting:

[legend]

Collaboration diagram for openmsx::IntegerSetting:

[legend]

Public Member Functions
	IntegerSetting (CommandController &commandController, std::string_view name, static_string_view description, int initialValue, int minValue, int 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().

int	getInt () const noexcept

void	setInt (int i)

int	getMinValue () const

int	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 an integer value.

Definition at line 10 of file IntegerSetting.hh.

Constructor & Destructor Documentation

◆ IntegerSetting()

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

Definition at line 5 of file IntegerSetting.cc.

References openmsx::TclObject::getInt(), openmsx::Setting::getInterpreter(), openmsx::Setting::init(), and openmsx::Setting::setChecker().

Member Function Documentation

◆ additionalInfo()

void openmsx::IntegerSetting::additionalInfo ( TclObject & result ) const

overridevirtual

Helper method for info().

Implements openmsx::BaseSetting.

Definition at line 27 of file IntegerSetting.cc.

References openmsx::TclObject::addListElement(), and openmsx::makeTclList().

◆ getInt()

int openmsx::IntegerSetting::getInt ( ) const

inlinenoexcept

Definition at line 21 of file IntegerSetting.hh.

References openmsx::TclObject::getInt(), openmsx::Setting::getInterpreter(), and openmsx::Setting::getValue().

Referenced by openmsx::Autofire::Autofire(), openmsx::RenderSettings::getBlurFactor(), openmsx::RenderSettings::getGlow(), openmsx::RenderSettings::getMaxFrameSkip(), openmsx::RenderSettings::getMinFrameSkip(), openmsx::RenderSettings::getScaleFactor(), openmsx::RenderSettings::getScanlineFactor(), and openmsx::RenderSettings::getScanlineGap().

◆ getMaxValue()

int openmsx::IntegerSetting::getMaxValue ( ) const

inline

Definition at line 25 of file IntegerSetting.hh.

◆ getMinValue()

int openmsx::IntegerSetting::getMinValue ( ) const

inline

Definition at line 24 of file IntegerSetting.hh.

◆ getTypeString()

std::string_view openmsx::IntegerSetting::getTypeString ( ) const

overridevirtual

Returns a string describing the setting type (integer, string, ..) Could be used in a GUI to pick an appropriate setting widget.

Implements openmsx::BaseSetting.

Definition at line 22 of file IntegerSetting.cc.

◆ setInt()

void openmsx::IntegerSetting::setInt ( int i )

Definition at line 32 of file IntegerSetting.cc.

References openmsx::Setting::setValue().

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

Public Member Functions

Additional Inherited Members