openMSX
Public Member Functions | List of all members
openmsx::VideoSourceSetting Class Referencefinal

#include <VideoSourceSetting.hh>

Inheritance diagram for openmsx::VideoSourceSetting:
Inheritance graph
[legend]
Collaboration diagram for openmsx::VideoSourceSetting:
Collaboration graph
[legend]

Public Member Functions

 VideoSourceSetting (CommandController &commandController)
 
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 additionalInfo (TclObject &result) const override
 Helper method for info(). More...
 
void tabCompletion (std::vector< std::string > &tokens) const override
 Complete a partly typed value. More...
 
int registerVideoSource (const std::string &source)
 
void unregisterVideoSource (int source)
 
int getSource () noexcept
 
void setSource (int id)
 
- Public Member Functions inherited from openmsx::Setting
 Setting (const Setting &)=delete
 
Settingoperator= (const Setting &)=delete
 
virtual ~Setting ()
 
const TclObjectgetValue () const final override
 Gets the current value of this setting as a TclObject. 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 override
 Change the value of this setting to the given value. More...
 
std::string_view getDescription () const final override
 pure virtual methods /// More...
 
TclObject getDefaultValue () const final override
 Get the default value of this setting. More...
 
TclObject getRestoreValue () const final override
 Get the value that will be set after a Tcl 'unset' command. More...
 
void setValueDirect (const TclObject &newValue) final override
 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 override
 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 override
 Does this setting need to be transfered on reverse. More...
 
void setDontSaveValue (const TclObject &dontSaveValue) final override
 This value will never end up in the settings.xml file. More...
 
CommandControllergetCommandController () const
 
InterpretergetInterpreter () const
 
- Public Member Functions inherited from openmsx::BaseSetting
const TclObjectgetFullNameObj () const
 Get the name of this setting. More...
 
const TclObjectgetBaseNameObj () 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...
 
- Public Member Functions inherited from openmsx::Subject< Setting >
void attach (Observer< Setting > &observer)
 
void detach (Observer< Setting > &observer)
 
bool anyObservers () const
 

Additional Inherited Members

- Public Types inherited from openmsx::Setting
enum  SaveSetting { SAVE, DONT_SAVE, DONT_TRANSFER }
 
- Protected Member Functions inherited from openmsx::Setting
 Setting (CommandController &commandController, std::string_view name, std::string_view description, const TclObject &initialValue, SaveSetting save=SAVE)
 
void init ()
 
void notifyPropertyChange () const
 
- Protected Member Functions inherited from openmsx::BaseSetting
 BaseSetting (std::string_view name)
 
 BaseSetting (const TclObject &name)
 
 ~BaseSetting ()=default
 
- Protected Member Functions inherited from openmsx::Subject< Setting >
 Subject ()=default
 
 ~Subject ()
 
void notify () const
 

Detailed Description

Definition at line 10 of file VideoSourceSetting.hh.

Constructor & Destructor Documentation

◆ VideoSourceSetting()

openmsx::VideoSourceSetting::VideoSourceSetting ( CommandController commandController)
explicit

Definition at line 11 of file VideoSourceSetting.cc.

Member Function Documentation

◆ additionalInfo()

void openmsx::VideoSourceSetting::additionalInfo ( TclObject result) const
overridevirtual

Helper method for info().

Implements openmsx::BaseSetting.

Definition at line 89 of file VideoSourceSetting.cc.

◆ getSource()

int openmsx::VideoSourceSetting::getSource ( )
noexcept

Definition at line 35 of file VideoSourceSetting.cc.

◆ getTypeString()

std::string_view openmsx::VideoSourceSetting::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 68 of file VideoSourceSetting.cc.

◆ registerVideoSource()

int openmsx::VideoSourceSetting::registerVideoSource ( const std::string &  source)

Definition at line 102 of file VideoSourceSetting.cc.

◆ setSource()

void openmsx::VideoSourceSetting::setSource ( int  id)

Definition at line 61 of file VideoSourceSetting.cc.

◆ tabCompletion()

void openmsx::VideoSourceSetting::tabCompletion ( std::vector< std::string > &  tokens) const
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 96 of file VideoSourceSetting.cc.

References openmsx::EnumSetting< T >::getEnum().

◆ unregisterVideoSource()

void openmsx::VideoSourceSetting::unregisterVideoSource ( int  source)

Definition at line 117 of file VideoSourceSetting.cc.


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