openMSX: openmsx::InfoTopic Class Reference

openMSX

#include <InfoTopic.hh>

Inheritance diagram for openmsx::InfoTopic:

Inheritance graph

Collaboration diagram for openmsx::InfoTopic:

Collaboration graph

Public Member Functions
virtual void	execute (const std::vector< TclObject > &tokens, TclObject &result) const =0
	Show info on this topic.
virtual std::string	help (const std::vector< std::string > &tokens) const =0
	Print help for this topic.
virtual void	tabCompletion (std::vector< std::string > &tokens) const
	Attempt tab completion for this topic.
Public Member Functions inherited from openmsx::Completer
const std::string &	getName () const

Protected Member Functions
	InfoTopic (InfoCommand &infoCommand, const std::string &name)
virtual	~InfoTopic ()
Protected Member Functions inherited from openmsx::Completer
	Completer (string_ref name)
virtual	~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 13 of file InfoTopic.hh.

Constructor & Destructor Documentation

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

protected

Definition at line 9 of file InfoTopic.cc.

References openmsx::Completer::getName(), and openmsx::InfoCommand::registerTopic().

openmsx::InfoTopic::~InfoTopic ( )

protectedvirtual

Definition at line 16 of file InfoTopic.cc.

References openmsx::Completer::getName(), and openmsx::InfoCommand::unregisterTopic().

Member Function Documentation

virtual void openmsx::InfoTopic::execute	(	const std::vector< TclObject > &	tokens,
		TclObject &	result
	)		const

pure virtual

Show info on this topic.

Parameters

tokens	Tokenized command line; tokens[1] is the topic.
result	The result of this topic must be assigned to this parameter.

Exceptions

CommandException Thrown when there was an error while executing this InfoTopic.

Implemented in openmsx::DeviceInfo, openmsx::MachineNameInfo, openmsx::RealTimeInfo, openmsx::ConfigInfo, openmsx::IOInfo, openmsx::ExternalSlotInfo, openmsx::SubSlottedInfo, openmsx::VDPInfo, openmsx::SlotInfo, openmsx::ConnectionClassInfo, openmsx::VersionInfo, openmsx::ConnectorInfo, openmsx::PluggableInfo, openmsx::FpsInfoTopic, openmsx::CartridgeSlotInfo, openmsx::CPUFreqInfoTopic, openmsx::SoundDeviceInfoTopic, openmsx::SoftwareInfoTopic, openmsx::TimeInfoTopic, openmsx::SettingInfo, and openmsx::RomInfoTopic.

virtual std::string openmsx::InfoTopic::help ( const std::vector< std::string > & tokens ) const

pure virtual

Print help for this topic.

Parameters

tokens Tokenized command line; tokens[1] is the topic.

Implements openmsx::Completer.

Implemented in openmsx::DeviceInfo, openmsx::MachineNameInfo, openmsx::RealTimeInfo, openmsx::ConfigInfo, openmsx::IOInfo, openmsx::ExternalSlotInfo, openmsx::SubSlottedInfo, openmsx::VDPInfo, openmsx::SlotInfo, openmsx::ConnectionClassInfo, openmsx::VersionInfo, openmsx::ConnectorInfo, openmsx::PluggableInfo, openmsx::FpsInfoTopic, openmsx::CartridgeSlotInfo, openmsx::CPUFreqInfoTopic, openmsx::SoundDeviceInfoTopic, openmsx::SoftwareInfoTopic, openmsx::TimeInfoTopic, openmsx::SettingInfo, and openmsx::RomInfoTopic.

void openmsx::InfoTopic::tabCompletion ( std::vector< std::string > & tokens ) const

virtual

Attempt tab completion for this topic.

Default implementation does nothing.

Parameters

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

Implements openmsx::Completer.

Reimplemented in openmsx::DeviceInfo, openmsx::ConfigInfo, 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: