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...
window *	get_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
	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	post_show (window &window) override
	Actions to be taken after the window has been shown. More...

Private Attributes
std::vector< unit_const_ptr > &	recall_list_
team &	team_
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_bool *	register_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_bool *	register_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_integer *	register_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_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...
field_text *	register_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_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...
field_label *	register_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_label *	register_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< window >	window_
	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 60 of file unit_recall.cpp.

Member Function Documentation

dismiss_unit()

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

private

Definition at line 342 of file unit_recall.cpp.

References _(), gui2::CANCEL, gui2::dialogs::dump_recall_list_to_console(), unit::experience(), filter_options_, recall_list_manager::find_if_matches_id(), unit::gender(), replay_helper::get_disband(), gui2::listbox::get_item_count(), gui2::listbox::get_selected_row(), gui2::dialogs::modal_dialog::get_window(), unit::id(), utf8::index(), unit::level(), list_item_clicked(), LOG_DP, unit::loyal(), unit_race::MALE, unit::max_experience(), gui2::OK, team::recall_list(), recall_list_, gui2::listbox::remove_row(), synced_context::run_and_throw(), gui2::dialogs::modal_dialog::set_retval(), gui2::show_message(), unit::side(), team_, and gui2::dialogs::message::yes_no_buttons.

Referenced by pre_show().

filter_text_changed()

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

private

Definition at line 439 of file unit_recall.cpp.

References gui2::listbox::any_rows_shown(), translation::ci_search(), filter_options_, gui2::listbox::get_item_count(), gui2::dialogs::modal_dialog::get_window(), i, last_words_, gui2::listbox::set_row_shown(), and utils::split().

Referenced by pre_show().

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 412 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

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the OK has been pressed).

Parameters

window

The window which has been shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 429 of file unit_recall.cpp.

References gui2::listbox::get_active_sorting_option(), gui2::dialogs::modal_dialog::get_retval(), gui2::listbox::get_selected_row(), gui2::OK, selected_index_, and gui2::dialogs::sort_last.

pre_show()

void gui2::dialogs::unit_recall::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

window

The window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 159 of file unit_recall.cpp.

References _(), unit::absolute_image(), gui2::listbox::add_row(), unit::can_advance(), unit::can_recruit(), gui2::listbox::clear(), gui2::event::connect_signal_mouse_left_click(), gui2::event::connect_signal_notify_modified(), resources::controller, dismiss_unit(), t_string::empty(), unit::experience(), unit::experience_to_advance(), filter_options_, filter_text_changed(), gui2::grid::find(), gui2::dialogs::format_cost_string(), gui2::dialogs::format_level_string(), gui2::image::get_image(), gui2::styled_widget::get_label(), gui2::dialogs::get_title_suffix(), team::gold(), i, unit::image_mods(), gui2::dialogs::inactive_row_color, unit::leader_crown(), unit::level(), list_item_clicked(), unit::max_experience(), gui2::dialogs::maybe_inactive(), unit::name(), unit::overlays(), game_config::recall_cost, team::recall_cost(), unit::recall_cost(), recall_list_, gui2::listbox::register_sorting_option(), gui2::listbox::register_translatable_sorting_option(), rename_unit(), gui2::listbox::set_active_sorting_option(), gui2::image::set_image(), gui2::styled_widget::set_label(), gui2::text_box_base::set_text_changed_callback(), show_help(), team::side(), gui2::dialogs::sort_default, gui2::dialogs::sort_last, font::span_color(), t_string::str(), team_, unit::trait_names(), unit::type_name(), font::unicode_en_dash, and unit::xp_color().

rename_unit()

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

private

Definition at line 309 of file unit_recall.cpp.

References _(), filter_options_, gui2::listbox::get_row_grid(), gui2::listbox::get_selected_row(), gui2::dialogs::modal_dialog::get_window(), utf8::index(), gui2::window::invalidate_layout(), unit::level(), list_item_clicked(), unit::name(), recall_list_, unit::rename(), unit::trait_names(), and unit::type_name().

Referenced by pre_show().

show_help()

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

private

Definition at line 407 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

The id of the window to build.

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:

• gui/dialogs/unit_recall.hpp
• gui/dialogs/unit_recall.cpp