The Battle for Wesnoth  1.15.12+dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::synched_choice_wait Class Reference

#include <synced_choice_wait.hpp>

Inheritance diagram for gui2::dialogs::synched_choice_wait:

Public Member Functions

 synched_choice_wait (user_choice_manager &mgr)
 
 ~synched_choice_wait ()
 
- Public Member Functions inherited from gui2::dialogs::modal_dialog
 modal_dialog ()
 
virtual ~modal_dialog ()
 
bool show (const unsigned auto_close_time=0)
 Shows the window. More...
 
windowget_window () const
 Returns a pointer to the dialog's window. More...
 
int get_retval () const
 Returns the cached window exit code. More...
 
void set_retval (int retval)
 Convenience wrapper to set the window's exit code. More...
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 
void set_allow_plugin_skip (const bool allow_plugin_skip)
 
void set_show_even_without_video (const bool show_even_without_video)
 
- Public Member Functions inherited from events::observer
virtual ~observer ()
 

Private Member Functions

virtual const std::string & window_id () const override
 The id of the window to build. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual void handle_generic_event (const std::string &event_name) override
 

Private Attributes

user_choice_managermgr_
 
labelmessage_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
 Creates a new integer field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
 Creates a new text field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new styled_widget as a label. More...
 
field_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new styled_widget as image. More...
 
- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

Definition at line 26 of file synced_choice_wait.hpp.

Constructor & Destructor Documentation

◆ synched_choice_wait()

gui2::dialogs::synched_choice_wait::synched_choice_wait ( user_choice_manager mgr)
explicit

Definition at line 36 of file synced_choice_wait.cpp.

◆ ~synched_choice_wait()

gui2::dialogs::synched_choice_wait::~synched_choice_wait ( )

Member Function Documentation

◆ handle_generic_event()

void gui2::dialogs::synched_choice_wait::handle_generic_event ( const std::string &  event_name)
overrideprivatevirtual

◆ pre_show()

void gui2::dialogs::synched_choice_wait::pre_show ( window window)
overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 48 of file synced_choice_wait.cpp.

References gui2::event::connect_signal_mouse_left_click(), user_choice_manager::finished(), message_, mgr_, quit_confirmation::quit_to_title(), gui2::styled_widget::set_label(), user_choice_manager::wait_message(), and user_choice_manager::waiting().

◆ window_id()

virtual const std::string& gui2::dialogs::synched_choice_wait::window_id ( ) const
overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ message_

label* gui2::dialogs::synched_choice_wait::message_
private

Definition at line 36 of file synced_choice_wait.hpp.

Referenced by handle_generic_event(), and pre_show().

◆ mgr_

user_choice_manager& gui2::dialogs::synched_choice_wait::mgr_
private

Definition at line 35 of file synced_choice_wait.hpp.

Referenced by handle_generic_event(), pre_show(), and ~synched_choice_wait().


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