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

#include <multiplayer_wait.hpp>

Inheritance diagram for mp::wait:
Inheritance graph

Classes

class  leader_preview_pane
 

Public Member Functions

 wait (CVideo &v, twesnothd_connection *wesnothd_connection, const config &cfg, saved_game &state, chat &c, config &gamelist, const bool first_scenario=true)
 
 ~wait ()
 
virtual void process_event ()
 
void join_game (bool observe)
 
void start_game ()
 
- Public Member Functions inherited from mp::ui
 ui (CVideo &v, twesnothd_connection *wesnothd_connection, const std::string &title, const config &cfg, chat &c, config &gamelist)
 
void process_network ()
 Asks the multiplayer_ui to pump some data from the network, and then to process it. More...
 
result get_result ()
 Returns the result of the current widget. More...
 
void set_location (const SDL_Rect &rect)
 Hides children, moves them (using layout_children), then shows them. More...
 
const std::vector< std::string > & user_list () const
 
void send_to_server (const config &cfg) override
 
bool receive_from_server (config &dst)
 
plugins_contextget_plugins_context ()
 
- Public Member Functions inherited from gui::widget
SDL_Rect const & location () const
 
void set_location (int x, int y)
 
void set_width (int w)
 
void set_height (int h)
 
void set_measurements (int w, int h)
 
int width () const
 
int height () const
 
bool focus (const SDL_Event *event)
 
void set_focus (bool focus)
 
virtual void hide (bool value=true)
 
bool hidden () const
 
virtual void enable (bool new_val=true)
 
bool enabled () const
 
void set_clip_rect (const SDL_Rect &rect)
 
void set_volatile (bool val=true)
 
void set_dirty (bool dirty=true)
 
bool dirty () const
 
const std::stringid () const
 
void set_id (const std::string &id)
 
void set_help_string (const std::string &str)
 
void set_tooltip_string (const std::string &str)
 
virtual void process_help_string (int mousex, int mousey)
 
virtual void process_tooltip_string (int mousex, int mousey)
 
- Public Member Functions inherited from events::sdl_handler
virtual bool requires_event_focus (const SDL_Event *=nullptr) const
 
virtual void join ()
 
virtual void join (context &c)
 
virtual void join_same (sdl_handler *parent)
 
virtual void leave ()
 
virtual void join_global ()
 
virtual void leave_global ()
 

Protected Member Functions

virtual void layout_children (const SDL_Rect &rect)
 Lays the children out. More...
 
virtual void hide_children (bool hide=true)
 Hides or shows all gui::widget children of this widget. More...
 
virtual void process_network_data (const config &data)
 Processes any pending network data. More...
 
- Protected Member Functions inherited from mp::ui
int xscale (int x) const
 
int yscale (int y) const
 
SDL_Rect client_area () const
 
CVideovideo ()
 
const configgame_config () const
 Returns the main game config, as defined by loading the preprocessed WML files. More...
 
virtual void draw_contents ()
 
virtual void handle_event (const SDL_Event &event)
 
virtual void handle_key_event (const SDL_KeyboardEvent &event)
 
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 chat_handler. More...
 
void send_chat_message (const std::string &message, bool allies_only=false)
 
void process_message (const config &msg, const bool whisper=false)
 Process chat messages. More...
 
result set_result (result res)
 Sets the result of this dialog, to be checked by get_result(). More...
 
void set_selected_game (const std::string &game_name)
 Sets the name of the selected game which is used to highlight the names of the players which have joined this game. More...
 
virtual void gamelist_updated (bool silent=true)
 Called each time the gamelist_ variable is updated. More...
 
void set_user_list (const std::vector< std::string > &, bool silent)
 Sets the user list. More...
 
void set_user_menu_items (const std::vector< std::string > &list)
 
configgamelist ()
 Returns the current gamelist. More...
 
void append_to_title (const std::string &name)
 
const gui::labeltitle () const
 
std::string get_selected_user_game ()
 
bool selected_user_changed () const
 
void set_selected_user_changed (const bool &changed)
 
- Protected Member Functions inherited from gui::widget
 widget (widget const &o)
 
 widget (CVideo &video, const bool auto_join=true)
 
virtual ~widget ()
 
void bg_register (SDL_Rect const &rect)
 
void bg_restore () const
 
void bg_restore (SDL_Rect const &rect) const
 
void bg_update ()
 
void bg_cancel ()
 
CVideovideo () const
 
virtual void draw ()
 
virtual void update_location (SDL_Rect const &rect)
 
const SDL_Rect * clip_rect () const
 
virtual sdl_handler_vector member_handlers ()
 
virtual void handle_window_event (SDL_Event const &event)
 
bool mouse_locked () const
 
void aquire_mouse_lock ()
 
void free_mouse_lock ()
 
- Protected Member Functions inherited from events::sdl_handler
 sdl_handler (const bool auto_join=true)
 
virtual ~sdl_handler ()
 
virtual std::vector
< sdl_handler * > 
handler_members ()
 

Private Member Functions

void generate_menu ()
 
bool download_level_data ()
 
configget_scenario ()
 
const configget_scenario () const
 
void process_event_impl (bool)
 

Private Attributes

gui::button cancel_button_
 
gui::label start_label_
 
gui::menu game_menu_
 
config level_
 
saved_gamestate_
 
const bool first_scenario_
 
bool stop_updates_
 

Additional Inherited Members

- Public Types inherited from mp::ui
enum  result {
  CONTINUE, JOIN, OBSERVE, CREATE,
  LOAD_GAME, PREFERENCES, PLAY, QUIT
}
 
enum  user_relation { ME, FRIEND, NEUTRAL, IGNORED }
 
enum  user_state { LOBBY, GAME, SEL_GAME }
 
- Protected Attributes inherited from mp::ui
CVideovideo_
 
twesnothd_connectionwesnothd_connection_
 
boost::scoped_ptr
< plugins_context
plugins_context_
 
- Protected Attributes inherited from gui::widget
bool focus_
 
- Static Protected Attributes inherited from mp::ui
static const int xscale_base = 1024
 
static const int yscale_base = 768
 

Detailed Description

Definition at line 24 of file multiplayer_wait.hpp.

Constructor & Destructor Documentation

mp::wait::wait ( CVideo v,
twesnothd_connection wesnothd_connection,
const config cfg,
saved_game state,
mp::chat c,
config gamelist,
const bool  first_scenario = true 
)
mp::wait::~wait ( )

Member Function Documentation

bool mp::wait::download_level_data ( )
private
void mp::wait::generate_menu ( )
private
config & mp::wait::get_scenario ( )
private

Definition at line 666 of file multiplayer_wait.cpp.

References config::child(), and level_.

Referenced by download_level_data(), generate_menu(), join_game(), and process_network_data().

const config & mp::wait::get_scenario ( ) const
private

Definition at line 677 of file multiplayer_wait.cpp.

References config::child(), and level_.

void mp::wait::hide_children ( bool  hide = true)
protectedvirtual

Hides or shows all gui::widget children of this widget.

Should be overridden by subclasses which add their own children.

Reimplemented from mp::ui.

Definition at line 424 of file multiplayer_wait.cpp.

References cancel_button_, game_menu_, gui::scrollarea::hide(), gui::widget::hide(), and mp::ui::hide_children().

void mp::wait::join_game ( bool  observe)
void mp::wait::layout_children ( const SDL_Rect &  rect)
protectedvirtual

Lays the children out.

This method is to be overridden by the subclasses of the mp_ui class; it will be called.

Reimplemented from mp::ui.

Definition at line 408 of file multiplayer_wait.cpp.

References gui::ButtonVPadding, cancel_button_, mp::ui::client_area(), game_menu_, gui::widget::height(), mp::ui::layout_children(), gui::widget::set_location(), gui::menu::set_max_height(), gui::menu::set_max_width(), gui::widget::set_measurements(), start_label_, mp::ui::title(), and gui::widget::width().

void mp::wait::process_event ( )
virtual

Reimplemented from mp::ui.

Definition at line 227 of file multiplayer_wait.cpp.

References cancel_button_, gui::button::pressed(), and process_event_impl().

void mp::wait::process_event_impl ( bool  quit)
private

Definition at line 232 of file multiplayer_wait.cpp.

References mp::ui::QUIT, and mp::ui::set_result().

Referenced by process_event(), and wait().

void mp::wait::process_network_data ( const config data)
protectedvirtual

Processes any pending network data.

Called by the public process_network() method. Overridden by subclasses who add more behavior for network.

Todo:
We should catch config::error and then leave the game.

Reimplemented from mp::ui.

Definition at line 432 of file multiplayer_wait.cpp.

References _(), config::apply_diff(), config::child(), config::child_count(), config::debug(), first_scenario_, generate_menu(), get_scenario(), config::has_child(), level_, LOG_NW, LOG_RG, mp::ui::PLAY, mp::ui::process_network_data(), mp::ui::QUIT, mp::ui::set_result(), gui2::show_transient_message(), stop_updates_, and mp::ui::video().

void mp::wait::start_game ( )

Member Data Documentation

gui::button mp::wait::cancel_button_
private

Definition at line 71 of file multiplayer_wait.hpp.

Referenced by hide_children(), layout_children(), and process_event().

const bool mp::wait::first_scenario_
private

Definition at line 78 of file multiplayer_wait.hpp.

Referenced by download_level_data(), join_game(), and process_network_data().

gui::menu mp::wait::game_menu_
private

Definition at line 73 of file multiplayer_wait.hpp.

Referenced by generate_menu(), hide_children(), layout_children(), and wait().

config mp::wait::level_
private
gui::label mp::wait::start_label_
private

Definition at line 72 of file multiplayer_wait.hpp.

Referenced by layout_children().

saved_game& mp::wait::state_
private

Definition at line 76 of file multiplayer_wait.hpp.

Referenced by join_game(), start_game(), and ~wait().

bool mp::wait::stop_updates_
private

Definition at line 79 of file multiplayer_wait.hpp.

Referenced by generate_menu(), and process_network_data().


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