openMSX
Public Member Functions | Protected Member Functions | List of all members
openmsx::InfoTopic Class Referenceabstract

#include <InfoTopic.hh>

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

Public Member Functions

virtual void execute (array_ref< TclObject > tokens, TclObject &result) const =0
 Show info on this topic. More...
 
virtual std::string help (const std::vector< std::string > &tokens) const =0
 Print help for this topic. More...
 
void tabCompletion (std::vector< std::string > &tokens) const override
 Attempt tab completion for this topic. More...
 
InterpretergetInterpreter () const
 
- Public Member Functions inherited from openmsx::Completer
const std::string & getName () const
 
template<typename ITER >
NEVER_INLINE std::vector
< string_ref
filter (string_ref str, ITER begin, ITER end, bool caseSensitive)
 

Protected Member Functions

 InfoTopic (InfoCommand &infoCommand, const std::string &name)
 
 ~InfoTopic ()
 
- Protected Member Functions inherited from openmsx::Completer
 Completer (string_ref name)
 
 ~Completer ()
 

Additional Inherited Members

- Static Public Member Functions inherited from openmsx::Completer
template<typename RANGE >
static void completeString (std::vector< std::string > &tokens, const RANGE &possibleValues, bool caseSensitive=true)
 
template<typename RANGE >
static void completeFileName (std::vector< std::string > &tokens, const FileContext &context, const RANGE &extra)
 
static void completeFileName (std::vector< std::string > &tokens, const FileContext &context)
 
static void setOutput (InterpreterOutput *output_)
 

Detailed Description

Definition at line 15 of file InfoTopic.hh.

Constructor & Destructor Documentation

openmsx::InfoTopic::InfoTopic ( InfoCommand infoCommand,
const std::string &  name 
)
protected
openmsx::InfoTopic::~InfoTopic ( )
protected

Member Function Documentation

virtual void openmsx::InfoTopic::execute ( array_ref< TclObject tokens,
TclObject result 
) const
pure virtual
Interpreter & openmsx::InfoTopic::getInterpreter ( ) const
virtual std::string openmsx::InfoTopic::help ( const std::vector< std::string > &  tokens) const
pure virtual
void openmsx::InfoTopic::tabCompletion ( std::vector< std::string > &  tokens) const
overridevirtual

Attempt tab completion for this topic.

Default implementation does nothing.

Parameters
tokensTokenized command line; tokens[1] is the topic. The last token is incomplete, this method tries to complete it.

Implements openmsx::Completer.

Reimplemented in openmsx::ConfigInfo, openmsx::DeviceInfo, openmsx::ConnectionClassInfo, openmsx::ConnectorInfo, openmsx::PluggableInfo, openmsx::SoundDeviceInfoTopic, openmsx::SoftwareInfoTopic, openmsx::SettingInfo, and openmsx::RomInfoTopic.

Definition at line 21 of file InfoTopic.cc.


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