openMSX
|
#include <BooleanSetting.hh>
Public Member Functions | |
BooleanSetting (CommandController &commandController, std::string_view name, static_string_view description, bool initialValue, SaveSetting save=SAVE) | |
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. More... | |
void | tabCompletion (std::vector< std::string > &tokens) const override |
Complete a partly typed value. More... | |
bool | getBoolean () const noexcept |
void | setBoolean (bool b) |
![]() | |
Setting (const Setting &)=delete | |
Setting & | operator= (const Setting &)=delete |
virtual | ~Setting () |
const TclObject & | getValue () const final |
Gets the current value of this setting as a TclObject. More... | |
std::optional< TclObject > | getOptionalValue () const final |
Like getValue(), but in case of error returns an empty optional instead of throwing an exception. More... | |
void | setRestoreValue (const TclObject &newRestoreValue) |
Set restore value. More... | |
void | setChecker (std::function< void(TclObject &)> checkFunc_) |
Set value-check-callback. More... | |
void | setValue (const TclObject &newValue) final |
Change the value of this setting to the given value. More... | |
std::string_view | getDescription () const final |
pure virtual methods /// More... | |
TclObject | getDefaultValue () const final |
Get the default value of this setting. More... | |
TclObject | getRestoreValue () const final |
Get the value that will be set after a Tcl 'unset' command. More... | |
void | setValueDirect (const TclObject &newValue) final |
Similar to setValue(), but doesn't trigger Tcl traces. More... | |
void | tabCompletion (std::vector< std::string > &tokens) const override |
Complete a partly typed value. More... | |
bool | needLoadSave () const final |
Does this setting need to be loaded or saved (settings.xml). More... | |
void | additionalInfo (TclObject &result) const override |
Helper method for info(). More... | |
bool | needTransfer () const final |
Does this setting need to be transfered on reverse. More... | |
void | setDontSaveValue (const TclObject &dontSaveValue) final |
This value will never end up in the settings.xml file. More... | |
CommandController & | getCommandController () const |
Interpreter & | getInterpreter () const |
![]() | |
const TclObject & | getFullNameObj () const |
Get the name of this setting. More... | |
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. More... | |
void | info (TclObject &result) const |
For SettingInfo. More... | |
virtual std::string_view | getDescription () const =0 |
pure virtual methods /// More... | |
virtual std::string_view | getTypeString () const =0 |
Returns a string describing the setting type (integer, string, ..) Could be used in a GUI to pick an appropriate setting widget. More... | |
virtual void | additionalInfo (TclObject &result) const =0 |
Helper method for info(). More... | |
virtual void | tabCompletion (std::vector< std::string > &tokens) const =0 |
Complete a partly typed value. More... | |
virtual const TclObject & | getValue () const =0 |
Get current value as a TclObject. More... | |
virtual std::optional< TclObject > | getOptionalValue () const =0 |
Like getValue(), but in case of error returns an empty optional instead of throwing an exception. More... | |
virtual TclObject | getDefaultValue () const =0 |
Get the default value of this setting. More... | |
virtual TclObject | getRestoreValue () const =0 |
Get the value that will be set after a Tcl 'unset' command. More... | |
virtual void | setValue (const TclObject &value)=0 |
Change the value of this setting to the given value. More... | |
virtual void | setValueDirect (const TclObject &value)=0 |
Similar to setValue(), but doesn't trigger Tcl traces. More... | |
virtual bool | needLoadSave () const =0 |
Does this setting need to be loaded or saved (settings.xml). More... | |
virtual bool | needTransfer () const =0 |
Does this setting need to be transfered on reverse. More... | |
virtual void | setDontSaveValue (const TclObject &dontSaveValue)=0 |
This value will never end up in the settings.xml file. More... | |
![]() | |
void | attach (Observer< Setting > &observer) |
void | detach (Observer< Setting > &observer) |
bool | anyObservers () const |
Additional Inherited Members | |
![]() | |
enum | SaveSetting { SAVE , DONT_SAVE , DONT_TRANSFER } |
![]() | |
Setting (CommandController &commandController, std::string_view name, static_string_view description, const TclObject &initialValue, SaveSetting save=SAVE) | |
void | init () |
void | notifyPropertyChange () const |
![]() | |
BaseSetting (std::string_view name) | |
BaseSetting (TclObject name) | |
~BaseSetting ()=default | |
![]() | |
Subject ()=default | |
~Subject () | |
void | notify () const |
Definition at line 8 of file BooleanSetting.hh.
openmsx::BooleanSetting::BooleanSetting | ( | CommandController & | commandController, |
std::string_view | name, | ||
static_string_view | description, | ||
bool | initialValue, | ||
SaveSetting | save = SAVE |
||
) |
Definition at line 7 of file BooleanSetting.cc.
References openmsx::TclObject::getBoolean(), openmsx::Setting::getInterpreter(), openmsx::Setting::init(), and openmsx::Setting::setChecker().
|
inlinenoexcept |
Definition at line 17 of file BooleanSetting.hh.
References openmsx::TclObject::getBoolean(), openmsx::Setting::getInterpreter(), and openmsx::Setting::getValue().
Referenced by openmsx::HDCommand::execute(), openmsx::KeyboardSettings::getAlwaysEnableKeypad(), openmsx::KeyboardSettings::getAutoToggleCodeKanaLock(), openmsx::RenderSettings::getDeflicker(), openmsx::RenderSettings::getDeinterlace(), openmsx::RenderSettings::getDisableSprites(), openmsx::RenderSettings::getFullScreen(), openmsx::RenderSettings::getInterleaveBlackFrame(), openmsx::FirmwareSwitch::getStatus(), openmsx::KeyboardSettings::getTraceKeyPresses(), openmsx::InputEventGenerator::InputEventGenerator(), openmsx::MSXMotherBoard::loadMachine(), openmsx::Mixer::Mixer(), openmsx::MSXTurboRPause::peekIO(), openmsx::MSXToshibaTcx200x::peekMem(), openmsx::PanasonicAudioPeriphery::read(), openmsx::FirmwareSwitch::~FirmwareSwitch(), and openmsx::GlobalSettings::~GlobalSettings().
|
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 BooleanSetting.cc.
|
inline |
Definition at line 20 of file BooleanSetting.hh.
References openmsx::Setting::setValue().
Referenced by openmsx::FirmwareSwitch::FirmwareSwitch(), openmsx::MSXMotherBoard::powerUp(), openmsx::MSXToshibaTcx200x::reset(), openmsx::MSXTurboRPause::reset(), and openmsx::MSXMotherBoard::serialize().
|
overridevirtual |
Complete a partly typed value.
Default implementation does not complete anything, subclasses can override this to complete according to their specific value type.
Implements openmsx::BaseSetting.
Definition at line 27 of file BooleanSetting.cc.
References openmsx::Completer::completeString(), and view::values().