The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::chatbox Class Reference

#include <chatbox.hpp>

Inheritance diagram for gui2::chatbox:
Inheritance graph

Public Member Functions

 chatbox (const implementation::builder_chatbox &builder)
 
virtual void set_active (const bool active) override
 See styled_widget::set_active. More...
 
virtual bool get_active () const override
 See styled_widget::get_active. More...
 
virtual unsigned get_state () const override
 See styled_widget::get_state. More...
 
void send_to_server (const ::config &cfg) override
 
void set_active_window_changed_callback (const std::function< void(void)> &f)
 
void set_lobby_info (mp::lobby_info &i)
 
void set_wesnothd_connection (wesnothd_connection &c)
 
virtual void send_chat_message (const std::string &message, bool) override
 inherited form chat_handler More...
 
void switch_to_window (lobby_chat_window *t)
 Switch to the window given by a valid pointer (e.g. More...
 
void switch_to_window (size_t id)
 
void active_window_changed ()
 
mp::room_infoactive_window_room ()
 Get the room* corresponding to the currently active window, or nullptr if a whisper window is active at the moment. More...
 
lobby_chat_windowroom_window_open (const std::string &room, const bool open_new, const bool allow_close=true)
 Check if a room window for "room" is open, if open_new is true then it will be created if not found. More...
 
lobby_chat_windowwhisper_window_open (const std::string &name, bool open_new)
 Check if a whisper window for user "name" is open, if open_new is true then it will be created if not found. More...
 
lobby_chat_windowsearch_create_window (const std::string &name, const bool whisper, const bool open_new, const bool allow_close)
 Helper function to find and open a new window, used by *_window_open. More...
 
void close_window_button_callback (lobby_chat_window &chat_window, bool &handled, bool &halt)
 
void process_room_join (const ::config &data)
 
void process_room_part (const ::config &data)
 
void process_room_query_response (const ::config &data)
 
void process_message (const ::config &data, bool whisper=false)
 
bool process_network_data (const ::config &data)
 
- Public Member Functions inherited from gui2::container_base
 container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
virtual SDL_Rect get_client_rect () const
 Returns the client rect. More...
 
virtual void layout_initialize (const bool full_initialization) override
 See widget::layout_initialize. More...
 
void reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a container. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See widget::request_reduce_width. More...
 
virtual void demand_reduce_width (const unsigned maximum_width) override
 See widget::demand_reduce_width. More...
 
void reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a container. More...
 
virtual void request_reduce_height (const unsigned maximum_height) override
 See widget::request_reduce_height. More...
 
virtual void demand_reduce_height (const unsigned maximum_height) override
 See widget::demand_reduce_height. More...
 
virtual bool can_wrap () const override
 See widget::can_wrap. More...
 
virtual void place (const point &origin, const point &size) override
 See widget::place. More...
 
virtual bool has_widget (const widget &widget) const override
 See widget::has_widget. More...
 
virtual void set_origin (const point &origin) override
 See widget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override
 See widget::set_visible_rectangle. More...
 
virtual void impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_children. More...
 
virtual widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
virtual iteration::walker_basecreate_walker () override
 See widget::create_walker. More...
 
void init_grid (const std::shared_ptr< builder_grid > &grid_builder)
 Initializes and builds the grid. More...
 
grid::iterator begin ()
 
grid::iterator end ()
 
unsigned add_row (const unsigned count=1)
 
void set_rows (const unsigned rows)
 
unsigned int get_rows () const
 
void set_cols (const unsigned cols)
 
unsigned int get_cols () const
 
void set_rows_cols (const unsigned rows, const unsigned cols)
 
void set_child (widget *widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)
 
void set_row_grow_factor (const unsigned row, const unsigned factor)
 
void set_column_grow_factor (const unsigned column, const unsigned factor)
 
const gridget_grid () const
 
gridget_grid ()
 
- Public Member Functions inherited from gui2::styled_widget
 styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const string_map &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
point get_config_minimum_size () const
 Gets the minimum size as defined in the config. More...
 
point get_config_default_size () const
 Gets the default size as defined in the config. More...
 
point get_config_maximum_size () const
 Gets the best size as defined in the config. More...
 
virtual unsigned get_characters_per_line () const
 Returns the number of characters per line. More...
 
virtual bool get_link_aware () const
 Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...
 
virtual color_t get_link_color () const
 Returns the color string to be used with links. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
bool get_use_tooltip_on_label_overflow () const
 
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
 
const t_stringget_label () const
 
virtual void set_label (const t_string &label)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_canvas (const unsigned index)
 
virtual void set_text_alignment (const PangoAlignment text_alignment)
 
PangoAlignment get_text_alignment () const
 
void set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)
 
PangoEllipsizeMode get_text_ellipse_mode () const
 Get the text's ellipsize mode. More...
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (const widget &)=delete
 
 widget ()
 
 widget (const builder_widget &builder)
 Constructor. More...
 
virtual ~widget () override
 
void set_id (const std::string &id)
 
const std::string & id () const
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
point get_best_size () const
 Gets the best size for the widget. More...
 
virtual bool can_mouse_focus () const
 Whether the mouse move/click event go 'through' this widget. More...
 
virtual void set_size (const point &size)
 Sets the size of the widget. More...
 
virtual void move (const int x_offset, const int y_offset)
 Moves a widget. More...
 
virtual void set_horizontal_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
virtual void set_vertical_alignment (const std::string &alignment)
 Sets the horizontal alignment of the widget within its parent grid. More...
 
point get_origin () const
 Returns the screen origin of the widget. More...
 
point get_size () const
 Returns the size of the widget. More...
 
SDL_Rect get_rectangle () const
 Gets the bounding rectangle of the widget on the screen. More...
 
int get_x () const
 
int get_y () const
 
unsigned get_width () const
 
unsigned get_height () const
 
void set_linked_group (const std::string &linked_group)
 
SDL_Rect calculate_blitting_rectangle (const int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (window &caller, std::vector< widget * > &call_stack)
 Adds a widget to the dirty list if it is dirty. More...
 
SDL_Rect get_dirty_rectangle () const
 Gets the dirty rectangle of the widget. More...
 
void set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
void set_visible (const visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned debug_border_mode)
 
void set_debug_border_color (const color_t debug_border_color)
 
- Public Member Functions inherited from gui2::event_executor
 event_executor ()
 
virtual ~event_executor ()
 
void set_wants_mouse_hover (const bool hover=true)
 
bool wants_mouse_hover () const
 
void set_wants_mouse_left_double_click (const bool click=true)
 
bool wants_mouse_left_double_click () const
 
void set_wants_mouse_middle_double_click (const bool click=true)
 
bool wants_mouse_middle_double_click () const
 
event_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::dispatcher
 dispatcher ()
 
virtual ~dispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. More...
 
bool has_event (const ui_event event, const event_queue_type event_type)
 
bool fire (const ui_event event, widget &target)
 Fires an event which has no extra parameters. More...
 
bool fire (const ui_event event, widget &target, const point &coordinate)
 Fires an event which takes a coordinate parameter. More...
 
bool fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const utf8::string &unicode)
 Fires an event which takes keyboard parameters. More...
 
bool fire (const ui_event event, widget &target, const point &pos, const point &distance)
 Fires an event which takes touch parameters. More...
 
bool fire (const ui_event event, widget &target, void *)
 Fires an event which takes notification parameters. More...
 
bool fire (const ui_event event, widget &target, message &msg)
 Fires an event which takes message parameters. More...
 
bool fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
 Fires an event that's a raw SDL event. More...
 
bool fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
 Fires an event which takes text input parameters. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. More...
 
void capture_mouse ()
 Captures the mouse. More...
 
void release_mouse ()
 Releases the mouse capture. More...
 
void set_mouse_behavior (const mouse_behavior mouse_behavior)
 
mouse_behavior get_mouse_behavior () const
 
void set_want_keyboard_input (const bool want_keyboard_input)
 
bool get_want_keyboard_input () const
 
void register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
 Registers a hotkey. More...
 
bool execute_hotkey (const hotkey::HOTKEY_COMMAND id)
 Executes a hotkey. More...
 
- Public Member Functions inherited from events::chat_handler
 chat_handler ()
 
virtual ~chat_handler ()
 
void send_command (const std::string &cmd, const std::string &args="")
 
virtual void send_to_server (const config &cfg)=0
 

Protected Member Functions

void finalize_setup ()
 Initializes the internal sub-widget pointers. More...
 
virtual void user_relation_changed (const std::string &name) override
 Called when a processed command results in a relation (friend/ignore) change for a user whose name is passed as the 'name' arg. More...
 
virtual void add_chat_message (const time_t &time, const std::string &speaker, int side, const std::string &message, events::chat_handler::MESSAGE_TYPE type=events::chat_handler::MESSAGE_PRIVATE) override
 inherited form chat_handler More...
 
virtual void add_whisper_sent (const std::string &receiver, const std::string &message) override
 inherited form chat_handler More...
 
virtual void add_whisper_received (const std::string &sender, const std::string &message) override
 inherited form chat_handler More...
 
virtual void add_chat_room_message_sent (const std::string &room, const std::string &message) override
 inherited form chat_handler More...
 
virtual void add_chat_room_message_received (const std::string &room, const std::string &speaker, const std::string &message) override
 inherited form chat_handler More...
 
- Protected Member Functions inherited from gui2::container_base
virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 
virtual void layout_children () override
 See widget::layout_children. More...
 
virtual void child_populate_dirty_list (window &caller, const std::vector< widget * > &call_stack) override
 See widget::child_populate_dirty_list. More...
 
- Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr config ()
 
resolution_definition_const_ptr config () const
 
template<typename T >
std::shared_ptr< const
typename T::resolution > 
cast_config_to () const
 Casts the current resolution definition config to the respective type of a derived widget. More...
 
void set_config (resolution_definition_ptr config)
 
virtual void update_canvas ()
 Updates the canvas(ses). More...
 
int get_text_maximum_width () const
 Returns the maximum width available for the text. More...
 
int get_text_maximum_height () const
 Returns the maximum height available for the text. More...
 
virtual void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_foreground. More...
 
std::string get_label_token (const gui2::point &position, const char *delimiters=" \n\r\t") const
 Exposes font::pango_text::get_token, for the text label of this styled_widget. More...
 
std::string get_label_link (const gui2::point &position) const
 
- Protected Member Functions inherited from gui2::widget
void set_layout_size (const point &size)
 
const pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 
- Protected Member Functions inherited from events::chat_handler
void do_speak (const std::string &message, bool allies_only=false)
 
virtual void send_whisper (const std::string &receiver, const std::string &message)
 
virtual void send_chat_room_message (const std::string &room, const std::string &message)
 
void change_logging (const std::string &data)
 Change the log level of a log domain. More...
 

Private Member Functions

mp::lobby_infoget_lobby_info ()
 
virtual const std::string & get_control_type () const override
 Inherited from styled_widget, implemented by REGISTER_WIDGET. More...
 
virtual void set_self_active (const bool active) override
 See container_base::set_self_active. More...
 
void chat_input_keypress_callback (bool &handled, bool &halt, const SDL_Keycode key)
 
void append_to_chatbox (const std::string &text, const bool force_scroll=false)
 
void append_to_chatbox (const std::string &text, size_t id, const bool force_scroll=false)
 
bool whisper_window_active (const std::string &name)
 
bool room_window_active (const std::string &room)
 
void increment_waiting_whsipers (const std::string &name)
 Mark the whisper window for "name" as having one more pending message. More...
 
void increment_waiting_messages (const std::string &room)
 Mark the room window for "room" as having one more pending message. More...
 
void add_whisper_window_whisper (const std::string &sender, const std::string &message)
 Add a whisper message to the whisper window. More...
 
void add_active_window_whisper (const std::string &sender, const std::string &message, const bool force_scroll=false)
 Add a whisper message to the current window which is not the whisper window for "name". More...
 
void add_room_window_message (const std::string &room, const std::string &sender, const std::string &message)
 Add a message to the window for room "room". More...
 
void add_active_window_message (const std::string &sender, const std::string &message, const bool force_scroll=false)
 Add a message to the window for room "room". More...
 
void close_window (size_t idx)
 
void send_message_button_callback ()
 

Private Attributes

listboxroomlistbox_
 
multi_pagechat_log_container_
 
text_boxchat_input_
 
std::vector< lobby_chat_windowopen_windows_
 
size_t active_window_
 
std::function< void(void)> active_window_changed_callback_
 
mp::lobby_infolobby_info_
 
wesnothd_connectionwesnothd_connection_
 

Friends

struct implementation::builder_chatbox
 

Additional Inherited Members

- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- Public Types inherited from gui2::event::dispatcher
enum  event_queue_type { pre = 1, child = 2, post = 4 }
 
enum  queue_position {
  front_pre_child, back_pre_child, front_child, back_child,
  front_post_child, back_post_child
}
 The position where to add a new callback in the signal handler. More...
 
enum  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 
- Public Types inherited from events::chat_handler
enum  MESSAGE_TYPE { MESSAGE_PUBLIC, MESSAGE_PRIVATE }
 

Detailed Description

Definition at line 55 of file chatbox.hpp.

Constructor & Destructor Documentation

gui2::chatbox::chatbox ( const implementation::builder_chatbox builder)
explicit

Definition at line 55 of file chatbox.cpp.

Member Function Documentation

void gui2::chatbox::active_window_changed ( )
mp::room_info * gui2::chatbox::active_window_room ( )

Get the room* corresponding to the currently active window, or nullptr if a whisper window is active at the moment.

Definition at line 557 of file chatbox.cpp.

References active_window_, mp::lobby_info::get_room(), lobby_info_, gui2::lobby_chat_window::name, open_windows_, t, and gui2::lobby_chat_window::whisper.

Referenced by process_room_join(), process_room_part(), process_room_query_response(), and gui2::dialogs::mp_lobby::update_playerlist().

void gui2::chatbox::add_active_window_message ( const std::string &  sender,
const std::string &  message,
const bool  force_scroll = false 
)
private

Add a message to the window for room "room".

Definition at line 548 of file chatbox.cpp.

References append_to_chatbox(), and font::escape_text().

Referenced by add_chat_room_message_received(), add_chat_room_message_sent(), add_whisper_received(), add_whisper_sent(), and process_room_query_response().

void gui2::chatbox::add_active_window_whisper ( const std::string &  sender,
const std::string &  message,
const bool  force_scroll = false 
)
private

Add a whisper message to the current window which is not the whisper window for "name".

Definition at line 484 of file chatbox.cpp.

References append_to_chatbox(), and font::escape_text().

Referenced by add_whisper_received(), and add_whisper_sent().

void gui2::chatbox::add_chat_message ( const time_t &  time,
const std::string &  speaker,
int  side,
const std::string &  message,
events::chat_handler::MESSAGE_TYPE  type = events::chat_handler::MESSAGE_PRIVATE 
)
overrideprotectedvirtual

inherited form chat_handler

Implements events::chat_handler.

Definition at line 241 of file chatbox.cpp.

References append_to_chatbox(), and font::escape_text().

Referenced by send_chat_message().

void gui2::chatbox::add_chat_room_message_received ( const std::string &  room,
const std::string &  speaker,
const std::string &  message 
)
overrideprotectedvirtual
void gui2::chatbox::add_chat_room_message_sent ( const std::string &  room,
const std::string &  message 
)
overrideprotectedvirtual
void gui2::chatbox::add_room_window_message ( const std::string &  room,
const std::string &  sender,
const std::string &  message 
)
private

Add a message to the window for room "room".

Definition at line 534 of file chatbox.cpp.

References append_to_chatbox(), ERR_LB, font::escape_text(), open_windows_, room_window_open(), and t.

Referenced by add_chat_room_message_received(), process_room_join(), and process_room_part().

void gui2::chatbox::add_whisper_received ( const std::string &  sender,
const std::string &  message 
)
overrideprotectedvirtual
void gui2::chatbox::add_whisper_sent ( const std::string &  receiver,
const std::string &  message 
)
overrideprotectedvirtual
void gui2::chatbox::add_whisper_window_whisper ( const std::string &  sender,
const std::string &  message 
)
private

Add a whisper message to the whisper window.

Definition at line 472 of file chatbox.cpp.

References append_to_chatbox(), ERR_LB, font::escape_text(), open_windows_, t, and whisper_window_open().

Referenced by add_whisper_received().

void gui2::chatbox::append_to_chatbox ( const std::string &  text,
const bool  force_scroll = false 
)
private
void gui2::chatbox::append_to_chatbox ( const std::string &  text,
size_t  id,
const bool  force_scroll = false 
)
private
void gui2::chatbox::chat_input_keypress_callback ( bool &  handled,
bool &  halt,
const SDL_Keycode  key 
)
private
void gui2::chatbox::close_window ( size_t  idx)
private
void gui2::chatbox::close_window_button_callback ( lobby_chat_window chat_window,
bool &  handled,
bool &  halt 
)

Definition at line 420 of file chatbox.cpp.

References close_window(), utf8::index(), gui2::lobby_chat_window::name, and open_windows_.

Referenced by search_create_window().

void gui2::chatbox::finalize_setup ( )
protected

Initializes the internal sub-widget pointers.

Should be called when building the window, so the pointers are initialized when set_displayed_type() is called.

Definition at line 99 of file chatbox.cpp.

References chat_input_, chat_input_keypress_callback(), chat_log_container_, gui2::event::connect_signal_notify_modified(), gui2::event::connect_signal_pre_key_press(), gui2::listbox::get_selected_row(), roomlistbox_, and switch_to_window().

Referenced by gui2::implementation::builder_chatbox::build().

bool gui2::chatbox::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 213 of file chatbox.cpp.

virtual const std::string& gui2::chatbox::get_control_type ( ) const
overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

mp::lobby_info& gui2::chatbox::get_lobby_info ( )
inlineprivate

Definition at line 130 of file chatbox.hpp.

References lobby_info_.

virtual unsigned gui2::chatbox::get_state ( ) const
inlineoverridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 69 of file chatbox.hpp.

void gui2::chatbox::increment_waiting_messages ( const std::string &  room)
private

Mark the room window for "room" as having one more pending message.

Definition at line 455 of file chatbox.cpp.

References DBG_LB, gui2::listbox::get_row_grid(), preferences::grid(), open_windows_, room_window_open(), roomlistbox_, gui2::widget::set_visible(), t, and gui2::widget::visible.

Referenced by add_chat_room_message_received().

void gui2::chatbox::increment_waiting_whsipers ( const std::string &  name)
private

Mark the whisper window for "name" as having one more pending message.

Definition at line 439 of file chatbox.cpp.

References DBG_LB, gui2::listbox::get_row_grid(), preferences::grid(), open_windows_, roomlistbox_, gui2::widget::set_visible(), t, gui2::widget::visible, and whisper_window_open().

Referenced by add_whisper_received().

void gui2::chatbox::process_message ( const ::config data,
bool  whisper = false 
)
bool gui2::chatbox::process_network_data ( const ::config data)
void gui2::chatbox::process_room_join ( const ::config data)
void gui2::chatbox::process_room_part ( const ::config data)
void gui2::chatbox::process_room_query_response ( const ::config data)
bool gui2::chatbox::room_window_active ( const std::string &  room)
private
Returns
true if the room window for "room" is the active window

Definition at line 351 of file chatbox.cpp.

References active_window_, gui2::lobby_chat_window::name, open_windows_, t, and gui2::lobby_chat_window::whisper.

Referenced by add_chat_room_message_received(), and add_chat_room_message_sent().

lobby_chat_window * gui2::chatbox::room_window_open ( const std::string &  room,
const bool  open_new,
const bool  allow_close = true 
)

Check if a room window for "room" is open, if open_new is true then it will be created if not found.

If allow_close is false, the 'close' button will be disabled.

Returns
valid ptr if the window was found or added, null otherwise

Definition at line 357 of file chatbox.cpp.

References search_create_window().

Referenced by add_chat_room_message_sent(), add_room_window_message(), increment_waiting_messages(), gui2::dialogs::mp_staging::pre_show(), gui2::dialogs::mp_join_game::pre_show(), gui2::dialogs::mp_lobby::pre_show(), process_room_join(), and process_room_query_response().

lobby_chat_window * gui2::chatbox::search_create_window ( const std::string &  name,
const bool  whisper,
const bool  open_new,
const bool  allow_close 
)
void gui2::chatbox::send_chat_message ( const std::string &  message,
bool   
)
overridevirtual
void gui2::chatbox::send_message_button_callback ( )
private
void gui2::chatbox::send_to_server ( const ::config cfg)
override

Definition at line 432 of file chatbox.cpp.

References wesnothd_connection::send_data(), and wesnothd_connection_.

Referenced by close_window().

void gui2::chatbox::set_active ( const bool  active)
overridevirtual

See styled_widget::set_active.

Reimplemented from gui2::container_base.

Definition at line 208 of file chatbox.cpp.

void gui2::chatbox::set_active_window_changed_callback ( const std::function< void(void)> &  f)
inline

Definition at line 73 of file chatbox.hpp.

References active_window_changed_callback_, and f.

Referenced by gui2::dialogs::mp_lobby::pre_show().

void gui2::chatbox::set_lobby_info ( mp::lobby_info i)
inline
void gui2::chatbox::set_self_active ( const bool  active)
overrideprivatevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 218 of file chatbox.cpp.

void gui2::chatbox::set_wesnothd_connection ( wesnothd_connection c)
inline
void gui2::chatbox::switch_to_window ( lobby_chat_window t)

Switch to the window given by a valid pointer (e.g.

received from a call to *_window_open)

Definition at line 83 of file chatbox.cpp.

References open_windows_.

Referenced by add_chat_room_message_sent(), add_whisper_sent(), finalize_setup(), process_room_join(), and gui2::dialogs::mp_lobby::user_dialog_callback().

void gui2::chatbox::switch_to_window ( size_t  id)
void gui2::chatbox::user_relation_changed ( const std::string &  name)
overrideprotectedvirtual

Called when a processed command results in a relation (friend/ignore) change for a user whose name is passed as the 'name' arg.

Reimplemented from events::chat_handler.

Definition at line 234 of file chatbox.cpp.

References active_window_changed_callback_.

bool gui2::chatbox::whisper_window_active ( const std::string &  name)
private
Returns
true if the whisper window for "name" is the active window

Definition at line 345 of file chatbox.cpp.

References active_window_, gui2::lobby_chat_window::name, open_windows_, t, and gui2::lobby_chat_window::whisper.

Referenced by add_whisper_received(), and add_whisper_sent().

lobby_chat_window * gui2::chatbox::whisper_window_open ( const std::string &  name,
bool  open_new 
)

Check if a whisper window for user "name" is open, if open_new is true then it will be created if not found.

Returns
valid ptr if the window was found or added, null otherwise

Definition at line 362 of file chatbox.cpp.

References search_create_window().

Referenced by add_whisper_received(), add_whisper_sent(), add_whisper_window_whisper(), increment_waiting_whsipers(), and gui2::dialogs::mp_lobby::user_dialog_callback().

Friends And Related Function Documentation

friend struct implementation::builder_chatbox
friend

Definition at line 57 of file chatbox.hpp.

Member Data Documentation

size_t gui2::chatbox::active_window_
private
std::function<void(void)> gui2::chatbox::active_window_changed_callback_
private
text_box* gui2::chatbox::chat_input_
private
multi_page* gui2::chatbox::chat_log_container_
private
mp::lobby_info* gui2::chatbox::lobby_info_
private
std::vector<lobby_chat_window> gui2::chatbox::open_windows_
private
listbox* gui2::chatbox::roomlistbox_
private
wesnothd_connection* gui2::chatbox::wesnothd_connection_
private

Definition at line 132 of file chatbox.hpp.

Referenced by send_chat_message(), send_to_server(), and set_wesnothd_connection().


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