console_gui.cpp File Reference

Handling the GUI of the in-game console. More...

#include "stdafx.h"
#include "textbuf_gui.h"
#include "window_gui.h"
#include "console_gui.h"
#include "console_internal.h"
#include "window_func.h"
#include "string_func.h"
#include "gfx_func.h"
#include "settings_type.h"
#include "rev.h"

Go to the source code of this file.

Data Structures

struct  IConsoleLine
 Container for a single line of console output. More...
struct  IConsoleWindow

Enumerations

enum  { ICON_HISTORY_SIZE = 20, ICON_LINE_SPACING = 2, ICON_RIGHT_BORDERWIDTH = 10, ICON_BOTTOM_BORDERWIDTH = 12 }
enum  ConsoleWidgets { CW_BACKGROUND }
 Widgets of the console window. More...

Functions

static void IConsoleClearCommand ()
static void IConsoleResetHistoryPos ()
static void IConsoleHistoryAdd (const char *cmd)
 Add the entered line into the history so you can look it back scroll, etc.
static void IConsoleHistoryNavigate (int direction)
 Navigate Up/Down in the history of typed commands.
void IConsoleGUIInit ()
void IConsoleClearBuffer ()
void IConsoleGUIFree ()
void IConsoleResize (Window *w)
void IConsoleSwitch ()
void IConsoleClose ()
void IConsoleGUIPrint (ConsoleColour colour_code, char *str)
 Handle the printing of text entered into the console or redirected there by any other means.

Variables

static Textbuf _iconsole_cmdline
static char * _iconsole_history [ICON_HISTORY_SIZE]
static byte _iconsole_historypos
IConsoleModes _iconsole_mode
static struct NWidgetPart _nested_console_window_widgets []
static const WindowDesc _console_window_desc (WDP_MANUAL, 0, 0, WC_CONSOLE, WC_NONE, 0, _nested_console_window_widgets, lengthof(_nested_console_window_widgets))


Detailed Description

Handling the GUI of the in-game console.

Definition in file console_gui.cpp.


Enumeration Type Documentation

Widgets of the console window.

Enumerator:
CW_BACKGROUND  Background of the console.

Definition at line 152 of file console_gui.cpp.


Function Documentation

void IConsoleGUIPrint ( ConsoleColour  colour_code,
char *  str 
)

Handle the printing of text entered into the console or redirected there by any other means.

Text can be redirected to other clients in a network game as well as to a logfile. If the network server is a dedicated server, all activities are also logged. All lines to print are added to a temporary buffer which can be used as a history to print them onscreen

Parameters:
colour_code the colour of the command. Red in case of errors, etc.
str the message entered or output on the console (notice, error, etc.)

Definition at line 473 of file console_gui.cpp.

References SetWindowDirty().

Referenced by IConsolePrint().

static void IConsoleHistoryAdd ( const char *  cmd  )  [static]

Add the entered line into the history so you can look it back scroll, etc.

Put it to the beginning as it is the latest text

Parameters:
cmd Text to be entered into the 'history'

Definition at line 416 of file console_gui.cpp.

References IsWhitespace(), and StrEmpty().

static void IConsoleHistoryNavigate ( int  direction  )  [static]

Navigate Up/Down in the history of typed commands.

Parameters:
direction Go further back in history (+1), go to recently typed commands (-1)

Definition at line 439 of file console_gui.cpp.

References IsInsideMM(), ttd_strlcpy(), and UpdateTextBufferSize().


Variable Documentation

struct NWidgetPart _nested_console_window_widgets[] [static]

Initial value:

 {
  NWidget(WWT_EMPTY, INVALID_COLOUR, CW_BACKGROUND), SetResize(1, 1),
}

Definition at line 156 of file console_gui.cpp.


Generated on Wed Dec 23 23:27:58 2009 for OpenTTD by  doxygen 1.5.6