FIFE::Console Class Reference

#include <console.h>

Collaboration diagram for FIFE::Console:

List of all members.

Public Member Functions
	Console ()
virtual	~Console ()
void	println (const std::string &s)
void	show ()
void	hide ()
void	clear ()
void	toggleShowHide ()
void	execute (std::string cmd)
void	updateCaption ()
void	updateAnimation ()
void	action (const gcn::ActionEvent &event)
void	setConsoleExecuter (ConsoleExecuter *const consoleexec)
void	removeConsoleExecuter ()
void	reLayout ()
void	setIOFont (GuiFont *font)
void	focusLost (const gcn::Event &event)

---

Detailed Description

Ingame Console

Definition at line 64 of file console.h.

---

Constructor & Destructor Documentation

FIFE::Console::Console

(

)

Constructor

Definition at line 49 of file console.cpp.

References execute(), reLayout(), FIFE::CommandLine::setCallback(), setIOFont(), updateAnimation(), and updateCaption().

FIFE::Console::~Console

(

)

[virtual]

Destructor

Definition at line 144 of file console.cpp.

---

Member Function Documentation

void FIFE::Console::action

(

const gcn::ActionEvent &

event

)

Callback from guichan to respond to button press

Definition at line 280 of file console.cpp.

References FIFE::ConsoleExecuter::onToolsClick().

void FIFE::Console::clear

(

)

Clear the console output

Definition at line 181 of file console.cpp.

void FIFE::Console::execute

(

std::string

cmd

)

Execute a command Normally just sends the command to runString() Checks whether the cmd is just one token and print it's value rather than throw an useless error.

Todo:

generalize the generated command and the regexp used.

Definition at line 227 of file console.cpp.

References FIFE::ConsoleExecuter::onConsoleCommand(), println(), and FIFE::Exception::what().

Referenced by Console().

Here is the caller graph for this function:

void FIFE::Console::focusLost

(

const gcn::Event &

event

)

Hide if we loose focus

Definition at line 301 of file console.cpp.

References hide().

void FIFE::Console::hide

(

)

Hide the console Removes itself from the toplevel container and pops it's input context

Definition at line 213 of file console.cpp.

Referenced by focusLost().

Here is the caller graph for this function:

void FIFE::Console::println

(

const std::string &

s

)

Print one or more lines to the console output

Definition at line 250 of file console.cpp.

Referenced by execute().

Here is the caller graph for this function:

void FIFE::Console::reLayout

(

)

Layouts the console to match e.g. font changes

Definition at line 89 of file console.cpp.

Referenced by Console().

Here is the caller graph for this function:

void FIFE::Console::removeConsoleExecuter

(

)

Removes executer for the console

Definition at line 292 of file console.cpp.

void FIFE::Console::setConsoleExecuter

(

ConsoleExecuter *const

consoleexec

)

Sets executer for the console

Definition at line 288 of file console.cpp.

void FIFE::Console::setIOFont

(

GuiFont *

font

)

Sets the font used for the input and output areas

Definition at line 296 of file console.cpp.

Referenced by Console().

Here is the caller graph for this function:

void FIFE::Console::show

(

)

Show the console Adds the Console to the guichan toplevel container and pushes an input Context so that keys are not send to the rest of the game.

Definition at line 205 of file console.cpp.

void FIFE::Console::toggleShowHide

(

)

Toggle the console Toggles whether the Console is shown or not. Calls show() or hide() respectively.

Definition at line 220 of file console.cpp.

void FIFE::Console::updateAnimation

(

)

Update the scroll in/out animation.

Note:

Is a timer callback.

Definition at line 165 of file console.cpp.

Referenced by Console().

Here is the caller graph for this function:

void FIFE::Console::updateCaption

(

)

Update the FPS caption

Note:

Is a timer callback.

Definition at line 158 of file console.cpp.

Referenced by Console().

Here is the caller graph for this function:

---

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

• engine/core/gui/guichan/console/console.h
• engine/core/gui/guichan/console/console.cpp