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

#include <FilenameSetting.hh>

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

Public Member Functions

 FilenameSetting (CommandController &commandController, string_ref name, string_ref description, string_ref initialValue)
 
string_ref 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...
 
- Public Member Functions inherited from openmsx::Setting
virtual ~Setting ()
 
const TclObjectgetValue () const
 Gets the current value of this setting as a TclObject. More...
 
void setRestoreValue (const std::string &value)
 Set restore value. More...
 
void setChecker (std::function< void(TclObject &)> checkFunc_)
 Set value-check-callback. More...
 
void setString (const std::string &value) finaloverride
 Change the value of this setting to the given value. More...
 
std::string getDescription () const finaloverride
 pure virtual methods /// More...
 
std::string getString () const finaloverride
 Get the current value of this setting in a string format that can be presented to the user. More...
 
std::string getDefaultValue () const finaloverride
 Get the default value of this setting. More...
 
std::string getRestoreValue () const finaloverride
 Get the value that will be set after a Tcl 'unset' command. More...
 
void setStringDirect (const std::string &value) finaloverride
 Similar to setString(), 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 finaloverride
 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 finaloverride
 Does this setting need to be transfered on reverse. More...
 
void setDontSaveValue (const std::string &dontSaveValue) finaloverride
 This value will never end up in the settings.xml file. More...
 
CommandControllergetCommandController () const
 
InterpretergetInterpreter () const
 
- Public Member Functions inherited from openmsx::BaseSetting
const std::string & getName () const
 Get the name of this setting. 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)
 

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, string_ref name, string_ref description, const std::string &initialValue, SaveSetting save=SAVE)
 
void init ()
 
void notifyPropertyChange () const
 
- Protected Member Functions inherited from openmsx::BaseSetting
 BaseSetting (string_ref name)
 
 ~BaseSetting ()
 
- Protected Member Functions inherited from openmsx::Subject< Setting >
 Subject ()
 
 ~Subject ()
 
void notify () const
 

Detailed Description

Definition at line 8 of file FilenameSetting.hh.

Constructor & Destructor Documentation

openmsx::FilenameSetting::FilenameSetting ( CommandController commandController,
string_ref  name,
string_ref  description,
string_ref  initialValue 
)

Definition at line 7 of file FilenameSetting.cc.

References openmsx::Setting::init().

Member Function Documentation

string_ref openmsx::FilenameSetting::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 17 of file FilenameSetting.cc.

void openmsx::FilenameSetting::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 22 of file FilenameSetting.cc.

References openmsx::Completer::completeFileName().


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