Engines::Jade::Console Class Reference

#include <console.h>

Inheritance diagram for Engines::Jade::Console:

Collaboration diagram for Engines::Jade::Console:

Public Member Functions
	Console (JadeEngine &engine)
	~Console ()
Public Member Functions inherited from Engines::Console
	Console (Engine &engine, const Common::UString &font, int fontHeight=0)
void	show ()
void	hide ()
bool	isVisible () const
float	getWidth () const
float	getHeight () const
size_t	getLines () const
size_t	getColumns () const
bool	processEvent (const Events::Event &event)
void	disableCommand (const Common::UString &cmd, const Common::UString &reason="")
void	enableCommand (const Common::UString &cmd)
void	clear ()
void	print (const Common::UString &line)
void	printf (const char *s,...) GCC_PRINTF(2

Private Member Functions
void	updateCaches ()
void	updateModules ()
void	cmdExitModule (const CommandLine &cl)
void	cmdListModules (const CommandLine &cl)
void	cmdLoadModule (const CommandLine &cl)

Private Attributes
JadeEngine *	_engine
std::vector< Common::UString >	_modules
	All known modules. More...

Additional Inherited Members
Protected Types inherited from Engines::Console
typedef boost::function< void(const CommandLine &cl)>	CommandCallback
Protected Member Functions inherited from Engines::Console
void	printException (Common::Exception &e, const Common::UString &prefix="ERROR: ")
bool	registerCommand (const Common::UString &cmd, const CommandCallback &callback, const Common::UString &help)
void	printCommandHelp (const Common::UString &cmd)
void	printList (const std::vector< Common::UString > &list, size_t maxSize=0)
void	setArguments (const Common::UString &cmd, const std::vector< Common::UString > &args)
void	setArguments (const Common::UString &cmd)
virtual void	showCallback ()
Static Protected Member Functions inherited from Engines::Console
static void	splitArguments (Common::UString argLine, std::vector< Common::UString > &args)

Detailed Description

Definition at line 38 of file console.h.

Constructor & Destructor Documentation

Console()

Engines::Jade::Console::Console

(

JadeEngine &

engine

)

Definition at line 48 of file console.cpp.

References cmdExitModule(), cmdListModules(), cmdLoadModule(), and Engines::Console::registerCommand().

Here is the call graph for this function:

~Console()

Engines::Jade::Console::~Console ( )

virtual

Reimplemented from Engines::Console.

Definition at line 60 of file console.cpp.

Member Function Documentation

cmdExitModule()

void Engines::Jade::Console::cmdExitModule ( const CommandLine &  cl )

private

Definition at line 76 of file console.cpp.

References _engine, Engines::Jade::Module::exit(), Engines::Jade::JadeEngine::getGame(), Engines::Jade::Game::getModule(), and Engines::Console::hide().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

cmdListModules()

void Engines::Jade::Console::cmdListModules ( const CommandLine &  cl )

private

Definition at line 81 of file console.cpp.

References _modules, Engines::Console::printList(), and updateModules().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

cmdLoadModule()

void Engines::Jade::Console::cmdLoadModule ( const CommandLine &  cl )

private

Definition at line 86 of file console.cpp.

References _engine, _modules, Engines::Console::CommandLine::args, Common::UString::c_str(), Engines::Console::CommandLine::cmd, Common::UString::empty(), Engines::Jade::JadeEngine::getGame(), Engines::Jade::Game::getModule(), Engines::Console::hide(), Engines::Jade::Module::load(), Engines::Console::printCommandHelp(), and Engines::Console::printf().

Referenced by Console().

Here is the call graph for this function:

Here is the caller graph for this function:

updateCaches()

void Engines::Jade::Console::updateCaches ( )

privatevirtual

Reimplemented from Engines::Console.

Definition at line 63 of file console.cpp.

References Engines::Console::updateCaches(), and updateModules().

Here is the call graph for this function:

updateModules()

void Engines::Jade::Console::updateModules ( )

private

Definition at line 69 of file console.cpp.

References _modules, Engines::Jade::Game::getModules(), and Engines::Console::setArguments().

Referenced by cmdListModules(), and updateCaches().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_engine

JadeEngine* Engines::Jade::Console::_engine

private

Definition at line 45 of file console.h.

Referenced by cmdExitModule(), and cmdLoadModule().

_modules

std::vector<Common::UString> Engines::Jade::Console::_modules

private

All known modules.

Definition at line 48 of file console.h.

Referenced by cmdListModules(), cmdLoadModule(), and updateModules().

---

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

• src/engines/jade/console.h
• src/engines/jade/console.cpp