OpenTTD
Data Structures | Functions | Variables
network_chat_gui.cpp File Reference

GUI for handling chat messages. More...

#include <stdarg.h>
#include "../stdafx.h"
#include "../strings_func.h"
#include "../blitter/factory.hpp"
#include "../console_func.h"
#include "../video/video_driver.hpp"
#include "../querystring_gui.h"
#include "../town.h"
#include "../window_func.h"
#include "../toolbar_gui.h"
#include "../core/geometry_func.hpp"
#include "network.h"
#include "network_client.h"
#include "network_base.h"
#include "../widgets/network_chat_widget.h"
#include "table/strings.h"
#include "../safeguards.h"

Go to the source code of this file.

Data Structures

struct  ChatMessage
 Container for a message. More...
struct  NetworkChatWindow
 Window to enter the chat message in. More...

Functions

 assert_compile ((int) DRAW_STRING_BUFFER >=(int) NETWORK_CHAT_LENGTH+NETWORK_NAME_LENGTH+40)
 The draw buffer must be able to contain the chat message, client name and the "[All]" message, some spaces and possible translations of [All] to other languages.
static uint GetChatMessageCount ()
 Count the chat messages.
void CDECL NetworkAddChatMessage (TextColour colour, uint duration, const char *message,...)
 Add a text message to the 'chat window' to be shown.
void NetworkReInitChatBoxSize ()
 Initialize all font-dependent chat box sizes.
void NetworkInitChatMessage ()
 Initialize all buffers of the chat visualisation.
void NetworkUndrawChatMessage ()
 Hide the chatbox.
void NetworkChatMessageLoop ()
 Check if a message is expired.
void NetworkDrawChatMessage ()
 Draw the chat message-box.
static void SendChat (const char *buf, DestType type, int dest)
 Send an actual chat message.
void ShowNetworkChatQueryWindow (DestType type, int dest)
 Show the chat window.

Variables

static const uint NETWORK_CHAT_LINE_SPACING = 3
 Spacing between chat lines.
static ChatMessage_chatmsg_list = NULL
 The actual chat message list.
static bool _chatmessage_dirty = false
 Does the chat message need repainting?
static bool _chatmessage_visible = false
 Is a chat message visible.
static bool _chat_tab_completion_active
 Whether tab completion is active.
static uint MAX_CHAT_MESSAGES = 0
 The limit of chat messages to show.
static PointDimension _chatmsg_box
 The chatbox grows from the bottom so the coordinates are pixels from the left and pixels from the bottom.
static uint8 * _chatmessage_backup = NULL
 Backup in case text is moved.
static const NWidgetPart _nested_chat_window_widgets []
 The widgets of the chat window.
static WindowDesc _chat_window_desc (WDP_MANUAL, NULL, 0, 0, WC_SEND_NETWORK_MSG, WC_NONE, 0, _nested_chat_window_widgets, lengthof(_nested_chat_window_widgets))
 The description of the chat window.

Detailed Description

GUI for handling chat messages.

Definition in file network_chat_gui.cpp.

Function Documentation

assert_compile ( (int) DRAW_STRING_BUFFER >=(int) NETWORK_CHAT_LENGTH+NETWORK_NAME_LENGTH 40)

The draw buffer must be able to contain the chat message, client name and the "[All]" message, some spaces and possible translations of [All] to other languages.

static uint GetChatMessageCount ( )
inlinestatic

Count the chat messages.

Returns
The number of chat messages.

Definition at line 68 of file network_chat_gui.cpp.

References MAX_CHAT_MESSAGES.

Referenced by NetworkAddChatMessage(), and NetworkDrawChatMessage().

void CDECL NetworkAddChatMessage ( TextColour  colour,
uint  duration,
const char *  message,
  ... 
)

Add a text message to the 'chat window' to be shown.

Parameters
colourThe colour this message is to be shown in
durationThe duration of the chat message in seconds
messagemessage itself in printf() style

Definition at line 84 of file network_chat_gui.cpp.

References _realtime_tick, ChatMessage::colour, DRAW_STRING_BUFFER, GetChatMessageCount(), lastof, ChatMessage::message, ChatMessage::remove_time, strecpy(), TC_IS_PALETTE_COLOUR, Utf8TrimString(), and vseprintf().

void NetworkChatMessageLoop ( )

Check if a message is expired.

Definition at line 180 of file network_chat_gui.cpp.

References _realtime_tick, MAX_CHAT_MESSAGES, ChatMessage::message, and ChatMessage::remove_time.

void NetworkInitChatMessage ( )
void NetworkReInitChatBoxSize ( )

Initialize all font-dependent chat box sizes.

Definition at line 110 of file network_chat_gui.cpp.

References FONT_HEIGHT_NORMAL, Blitter::GetBytesPerPixel(), BlitterFactory::GetCurrentBlitter(), NETWORK_CHAT_LINE_SPACING, and ReallocT().

Referenced by NetworkInitChatMessage(), and ReInitAllWindows().

static void SendChat ( const char *  buf,
DestType  type,
int  dest 
)
static

Send an actual chat message.

Parameters
bufThe message to send.
typeThe type of destination.
destThe actual destination index.

Definition at line 272 of file network_chat_gui.cpp.

References _network_server, CLIENT_ID_SERVER, NetworkServerSendChat(), ClientNetworkGameSocketHandler::SendChat(), and StrEmpty().

Referenced by NetworkChatWindow::OnClick().

void ShowNetworkChatQueryWindow ( DestType  type,
int  dest 
)

Show the chat window.

Parameters
typeThe type of destination.
destThe actual destination index.

Definition at line 557 of file network_chat_gui.cpp.

References _chat_window_desc, DeleteWindowByClass(), and WC_SEND_NETWORK_MSG.

Referenced by MainWindow::OnHotkey().

Variable Documentation

The description of the chat window.

Referenced by ShowNetworkChatQueryWindow().

PointDimension _chatmsg_box
static

The chatbox grows from the bottom so the coordinates are pixels from the left and pixels from the bottom.

The height is the maximum height.

Definition at line 61 of file network_chat_gui.cpp.

const NWidgetPart _nested_chat_window_widgets[]
static
Initial value:
{
NWidget(WWT_TEXT, COLOUR_GREY, WID_NC_DESTINATION), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetDataTip(STR_NULL, STR_NULL),
NWidget(WWT_EDITBOX, COLOUR_GREY, WID_NC_TEXTBOX), SetMinimalSize(100, 12), SetPadding(1, 0, 1, 0), SetResize(1, 0),
SetDataTip(STR_NETWORK_CHAT_OSKTITLE, STR_NULL),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NC_SENDBUTTON), SetMinimalSize(62, 12), SetPadding(1, 0, 1, 0), SetDataTip(STR_NETWORK_CHAT_SEND, STR_NULL),
}

The widgets of the chat window.

Definition at line 529 of file network_chat_gui.cpp.

const uint NETWORK_CHAT_LINE_SPACING = 3
static

Spacing between chat lines.

Definition at line 41 of file network_chat_gui.cpp.

Referenced by NetworkDrawChatMessage(), and NetworkReInitChatBoxSize().