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

#include <unit_recall.hpp>

Inheritance diagram for gui2::dialogs::unit_recall:

Public Member Functions

 unit_recall (std::vector< unit_const_ptr > &recall_list, team &team)
 
int get_selected_index () const
 
- 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)
 

Private Member Functions

void list_item_clicked ()
 Callbacks. More...
 
void filter_text_changed (const std::string &text)
 
void rename_unit ()
 
void dismiss_unit ()
 
void show_help ()
 
virtual const std::string & window_id () const override
 Inherited from modal_dialog, implemented by REGISTER_DIALOG. More...
 
virtual void pre_show (window &window) override
 Inherited from modal_dialog. More...
 
virtual void post_show (window &window) override
 Inherited from modal_dialog. More...
 

Private Attributes

std::vector< unit_const_ptr > & recall_list_
 
teamteam_
 
int selected_index_
 
std::vector< std::string > filter_options_
 
std::vector< std::string > last_words_
 

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 35 of file unit_recall.hpp.

Constructor & Destructor Documentation

◆ unit_recall()

gui2::dialogs::unit_recall::unit_recall ( std::vector< unit_const_ptr > &  recall_list,
team team 
)

Definition at line 62 of file unit_recall.cpp.

Member Function Documentation

◆ dismiss_unit()

void gui2::dialogs::unit_recall::dismiss_unit ( )
private

◆ filter_text_changed()

void gui2::dialogs::unit_recall::filter_text_changed ( const std::string &  text)
private

◆ get_selected_index()

int gui2::dialogs::unit_recall::get_selected_index ( ) const
inline

Definition at line 40 of file unit_recall.hpp.

References selected_index_.

Referenced by events::menu_handler::recall().

◆ list_item_clicked()

void gui2::dialogs::unit_recall::list_item_clicked ( )
private

Callbacks.

Definition at line 414 of file unit_recall.cpp.

References gui2::dialogs::modal_dialog::get_window(), recall_list_, and unit::unrenamable().

Referenced by dismiss_unit(), pre_show(), and rename_unit().

◆ post_show()

void gui2::dialogs::unit_recall::post_show ( window window)
overrideprivatevirtual

◆ pre_show()

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

◆ rename_unit()

void gui2::dialogs::unit_recall::rename_unit ( )
private

◆ show_help()

void gui2::dialogs::unit_recall::show_help ( )
private

Definition at line 409 of file unit_recall.cpp.

References help::show_help().

Referenced by pre_show().

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ filter_options_

std::vector<std::string> gui2::dialogs::unit_recall::filter_options_
private

Definition at line 52 of file unit_recall.hpp.

Referenced by dismiss_unit(), filter_text_changed(), pre_show(), and rename_unit().

◆ last_words_

std::vector<std::string> gui2::dialogs::unit_recall::last_words_
private

Definition at line 53 of file unit_recall.hpp.

Referenced by filter_text_changed().

◆ recall_list_

std::vector<unit_const_ptr>& gui2::dialogs::unit_recall::recall_list_
private

Definition at line 46 of file unit_recall.hpp.

Referenced by dismiss_unit(), list_item_clicked(), pre_show(), and rename_unit().

◆ selected_index_

int gui2::dialogs::unit_recall::selected_index_
private

Definition at line 50 of file unit_recall.hpp.

Referenced by get_selected_index(), and post_show().

◆ team_

team& gui2::dialogs::unit_recall::team_
private

Definition at line 48 of file unit_recall.hpp.

Referenced by dismiss_unit(), and pre_show().


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