From 2a1c1a81fcf1972a2dbf58c7115b70e1b2a461d3 Mon Sep 17 00:00:00 2001
From: Charles Dang <exodia339@gmail.com>
Date: Wed, 23 Aug 2017 15:57:29 +1100
Subject: [PATCH] GUI2: convert uses of 'state changed' callbacks to
 NOTIFY_MODIFIED signal handlers

---
 src/gui/auxiliary/field.hpp                   |  2 +-
 src/gui/dialogs/campaign_selection.cpp        |  8 +++--
 src/gui/dialogs/drop_down_menu.cpp            |  2 +-
 src/gui/dialogs/editor/resize_map.cpp         |  5 ++-
 src/gui/dialogs/label_settings.cpp            |  3 +-
 src/gui/dialogs/lobby/lobby.cpp               | 33 +++++++++++--------
 src/gui/dialogs/lobby/lobby.hpp               |  4 +--
 .../dialogs/multiplayer/mp_create_game.cpp    |  2 +-
 .../dialogs/multiplayer/mp_options_helper.cpp |  3 +-
 src/gui/dialogs/preferences_dialog.cpp        |  8 +++--
 src/gui/widgets/generator.cpp                 |  6 ++--
 src/gui/widgets/group.hpp                     |  2 +-
 src/gui/widgets/listbox.cpp                   | 17 ++++++++--
 src/gui/widgets/toggle_button.cpp             |  2 --
 src/scripting/lua_gui2.cpp                    |  2 +-
 15 files changed, 62 insertions(+), 37 deletions(-)

diff --git a/src/gui/auxiliary/field.hpp b/src/gui/auxiliary/field.hpp
index d1a3cb42f8f1..974c2ca06ade 100644
--- a/src/gui/auxiliary/field.hpp
+++ b/src/gui/auxiliary/field.hpp
@@ -579,7 +579,7 @@ class field_bool : public field<bool, selectable_item>
 					callback_change_(*widget);
 				}
 
-				dynamic_cast<selectable_item*>(widget)->set_callback_state_change(callback_change_);
+				connect_signal_notify_modified(*widget, std::bind(callback_change_, _1));
 			}
 		}
 	}
diff --git a/src/gui/dialogs/campaign_selection.cpp b/src/gui/dialogs/campaign_selection.cpp
index b6dac88ee877..f90a06df2364 100644
--- a/src/gui/dialogs/campaign_selection.cpp
+++ b/src/gui/dialogs/campaign_selection.cpp
@@ -191,8 +191,12 @@ void campaign_selection::pre_show(window& window)
 
 	toggle_button& sort_name = find_widget<toggle_button>(&window, "sort_name", false);
 	toggle_button& sort_time = find_widget<toggle_button>(&window, "sort_time", false);
-	sort_name.set_callback_state_change(std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), NAME));
-	sort_time.set_callback_state_change(std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), DATE));
+
+	connect_signal_notify_modified(sort_name,
+		std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), NAME));
+
+	connect_signal_notify_modified(sort_time,
+		std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), DATE));
 
 	window.keyboard_capture(&tree);
 
diff --git a/src/gui/dialogs/drop_down_menu.cpp b/src/gui/dialogs/drop_down_menu.cpp
index 55154417d00c..19f519ff3fe9 100644
--- a/src/gui/dialogs/drop_down_menu.cpp
+++ b/src/gui/dialogs/drop_down_menu.cpp
@@ -154,7 +154,7 @@ void drop_down_menu::pre_show(window& window)
 			checkbox->set_value_bool(entry["checkbox"].to_bool(false));
 
 			if(callback_toggle_state_change_ != nullptr) {
-				checkbox->set_callback_state_change(std::bind(callback_toggle_state_change_));
+				connect_signal_notify_modified(*checkbox, std::bind(callback_toggle_state_change_));
 			}
 
 			grid* mi_grid = dynamic_cast<grid*>(new_row.find("menu_item", false));
diff --git a/src/gui/dialogs/editor/resize_map.cpp b/src/gui/dialogs/editor/resize_map.cpp
index 4ede2a9bace4..072548637e7e 100644
--- a/src/gui/dialogs/editor/resize_map.cpp
+++ b/src/gui/dialogs/editor/resize_map.cpp
@@ -128,9 +128,8 @@ void editor_resize_map::pre_show(window& window)
 		direction_buttons_[i]
 				= find_widget<toggle_button>(&window, name, false, true);
 
-		direction_buttons_[i]->set_callback_state_change(
-				dialog_callback<editor_resize_map,
-								&editor_resize_map::update_expand_direction>);
+		connect_signal_notify_modified(*direction_buttons_[i],
+			std::bind(&editor_resize_map::update_expand_direction, this, std::ref(window)));
 	}
 	direction_buttons_[0]->set_value(true);
 	update_expand_direction(window);
diff --git a/src/gui/dialogs/label_settings.cpp b/src/gui/dialogs/label_settings.cpp
index f905385577d5..01fa09aae91c 100644
--- a/src/gui/dialogs/label_settings.cpp
+++ b/src/gui/dialogs/label_settings.cpp
@@ -103,7 +103,8 @@ void label_settings::pre_show(window& window) {
 
 		toggle_button& status = find_widget<toggle_button>(grid, "cat_status", false);
 		status.set_value(visible);
-		status.set_callback_state_change(std::bind(&label_settings::toggle_category, this, _1, category));
+
+		connect_signal_notify_modified(status, std::bind(&label_settings::toggle_category, this, _1, category));
 
 		if(category.substr(0,5) == "side:") {
 			label& cat_name = find_widget<label>(grid, "cat_name", false);
diff --git a/src/gui/dialogs/lobby/lobby.cpp b/src/gui/dialogs/lobby/lobby.cpp
index 3b60ca946c30..4e63334210e9 100644
--- a/src/gui/dialogs/lobby/lobby.cpp
+++ b/src/gui/dialogs/lobby/lobby.cpp
@@ -684,10 +684,11 @@ void mp_lobby::pre_show(window& window)
 	player_list_.sort_by_relation->set_value(preferences::playerlist_sort_relation());
 	player_list_.update_sort_icons();
 
-	player_list_.sort_by_name->set_callback_state_change(
-			std::bind(&mp_lobby::player_filter_callback, this, _1));
-	player_list_.sort_by_relation->set_callback_state_change(
-			std::bind(&mp_lobby::player_filter_callback, this, _1));
+	connect_signal_notify_modified(*player_list_.sort_by_name,
+		std::bind(&mp_lobby::player_filter_callback, this));
+
+	connect_signal_notify_modified(*player_list_.sort_by_relation,
+		std::bind(&mp_lobby::player_filter_callback, this));
 
 	window.set_enter_disabled(true);
 
@@ -742,14 +743,18 @@ void mp_lobby::pre_show(window& window)
 	filter_invert_  = find_widget<toggle_button>(&window, "filter_invert", false, true);
 	filter_text_    = find_widget<text_box>(&window, "filter_text", false, true);
 
-	filter_friends_->set_callback_state_change(
-			std::bind(&mp_lobby::game_filter_change_callback, this, _1));
-	filter_ignored_->set_callback_state_change(
-			std::bind(&mp_lobby::game_filter_change_callback, this, _1));
-	filter_slots_->set_callback_state_change(
-			std::bind(&mp_lobby::game_filter_change_callback, this, _1));
-	filter_invert_->set_callback_state_change(
-			std::bind(&mp_lobby::game_filter_change_callback, this, _1));
+	connect_signal_notify_modified(*filter_friends_,
+		std::bind(&mp_lobby::game_filter_change_callback, this));
+
+	connect_signal_notify_modified(*filter_ignored_,
+		std::bind(&mp_lobby::game_filter_change_callback, this));
+
+	connect_signal_notify_modified(*filter_slots_,
+		std::bind(&mp_lobby::game_filter_change_callback, this));
+
+	connect_signal_notify_modified(*filter_invert_,
+		std::bind(&mp_lobby::game_filter_change_callback, this));
+
 	connect_signal_pre_key_press(
 			*filter_text_,
 			std::bind(&mp_lobby::game_filter_keypress_callback, this, _5));
@@ -1062,7 +1067,7 @@ void mp_lobby::game_filter_keypress_callback(const SDL_Keycode key)
 	}
 }
 
-void mp_lobby::game_filter_change_callback(gui2::widget& /*widget*/)
+void mp_lobby::game_filter_change_callback()
 {
 	game_filter_reload();
 	update_gamelist_filter();
@@ -1073,7 +1078,7 @@ void mp_lobby::gamelist_change_callback(window& /*window*/)
 	update_selected_game();
 }
 
-void mp_lobby::player_filter_callback(gui2::widget& /*widget*/)
+void mp_lobby::player_filter_callback()
 {
 	player_list_.update_sort_icons();
 
diff --git a/src/gui/dialogs/lobby/lobby.hpp b/src/gui/dialogs/lobby/lobby.hpp
index 01704db383e0..0e5b4f0039d2 100644
--- a/src/gui/dialogs/lobby/lobby.hpp
+++ b/src/gui/dialogs/lobby/lobby.hpp
@@ -138,13 +138,13 @@ class mp_lobby : public modal_dialog, public quit_confirmation, private plugin_e
 
 	void game_filter_reload();
 
-	void game_filter_change_callback(widget& widget);
+	void game_filter_change_callback();
 
 	void game_filter_keypress_callback(const SDL_Keycode key);
 
 	void gamelist_change_callback(window& window);
 
-	void player_filter_callback(widget& widget);
+	void player_filter_callback();
 
 	void user_dialog_callback(mp::user_info* info);
 
diff --git a/src/gui/dialogs/multiplayer/mp_create_game.cpp b/src/gui/dialogs/multiplayer/mp_create_game.cpp
index a6b907d433bd..c0ea8cc83c01 100644
--- a/src/gui/dialogs/multiplayer/mp_create_game.cpp
+++ b/src/gui/dialogs/multiplayer/mp_create_game.cpp
@@ -247,7 +247,7 @@ void mp_create_game::pre_show(window& win)
 			mog_toggle.set_value_bool(true);
 		}
 
-		mog_toggle.set_callback_state_change(std::bind(&mp_create_game::on_mod_toggle, this, i));
+		connect_signal_notify_modified(mog_toggle, std::bind(&mp_create_game::on_mod_toggle, this, i));
 	}
 
 	connect_signal_notify_modified(mod_list, std::bind(&mp_create_game::on_mod_select, this, std::ref(win)));
diff --git a/src/gui/dialogs/multiplayer/mp_options_helper.cpp b/src/gui/dialogs/multiplayer/mp_options_helper.cpp
index 4a0bf5fb0b73..fe441b3a6c62 100644
--- a/src/gui/dialogs/multiplayer/mp_options_helper.cpp
+++ b/src/gui/dialogs/multiplayer/mp_options_helper.cpp
@@ -238,7 +238,8 @@ void mp_options_helper::display_custom_options(const std::string& type, int node
 				std::tie(checkbox, val) = add_node_and_get_widget<toggle_button>(option_node, "option_checkbox", data, option_cfg);
 
 				checkbox->set_value(val.to_bool());
-				checkbox->set_callback_state_change(
+
+				connect_signal_notify_modified(*checkbox,
 					std::bind(&mp_options_helper::update_options_data_map<toggle_button>, this, checkbox, visible_options_.back()));
 
 			} else if(opt.key == "spacer") {
diff --git a/src/gui/dialogs/preferences_dialog.cpp b/src/gui/dialogs/preferences_dialog.cpp
index ac194634fc24..d2537c1e135f 100644
--- a/src/gui/dialogs/preferences_dialog.cpp
+++ b/src/gui/dialogs/preferences_dialog.cpp
@@ -652,9 +652,11 @@ void preferences_dialog::post_build(window& window)
 
 				menu.set_use_markup(true);
 				menu.set_values(menu_data, selected);
-				menu.set_callback_state_change([=](widget& w) {
-					set(pref_name, option_ids[dynamic_cast<menu_button&>(w).get_value()]);
-				});
+
+				// We need to bind a lambda here since preferences::set is overloaded.
+				// A lambda alone would be more verbose because it'd need to specify all the parameters.
+				connect_signal_notify_modified(menu,
+					std::bind([=](widget& w) { set(pref_name, option_ids[dynamic_cast<menu_button&>(w).get_value()]); }, _1));
 
 				gui2::bind_status_label<menu_button>(main_grid, "setter", [](menu_button& m)->std::string {
 					return m.get_value_string();
diff --git a/src/gui/widgets/generator.cpp b/src/gui/widgets/generator.cpp
index 39b0c5bbea64..286d7c98de3d 100644
--- a/src/gui/widgets/generator.cpp
+++ b/src/gui/widgets/generator.cpp
@@ -1074,7 +1074,8 @@ selection::init(grid* g,
 			toggle_panel* panel = dynamic_cast<toggle_panel*>(widget);
 
 			if(btn) {
-				btn->set_callback_state_change(callback);
+				connect_signal_notify_modified(*btn, std::bind(callback, _1));
+
 				std::map<std::string, string_map>::const_iterator itor
 						= data.find(btn->id());
 
@@ -1085,7 +1086,8 @@ selection::init(grid* g,
 					btn->set_members(itor->second);
 				}
 			} else if(panel) {
-				panel->set_callback_state_change(callback);
+				connect_signal_notify_modified(*panel, std::bind(callback, _1));
+
 				panel->set_child_members(data);
 			} else if(child_grid) {
 				init(child_grid, data, callback);
diff --git a/src/gui/widgets/group.hpp b/src/gui/widgets/group.hpp
index f4c03b11124a..e69755d42774 100644
--- a/src/gui/widgets/group.hpp
+++ b/src/gui/widgets/group.hpp
@@ -127,7 +127,7 @@ class group
 		};
 
 		for(auto& member : members_) {
-			member.second->set_callback_state_change(callback);
+			event::connect_signal_notify_modified(dynamic_cast<widget&>(*member.second), std::bind(callback, _1));
 		}
 	}
 
diff --git a/src/gui/widgets/listbox.cpp b/src/gui/widgets/listbox.cpp
index 213589880c17..1b75c5bcee19 100644
--- a/src/gui/widgets/listbox.cpp
+++ b/src/gui/widgets/listbox.cpp
@@ -532,16 +532,29 @@ void listbox::finalize(builder_grid_const_ptr header,
 	if(header) {
 		swap_grid(&get_grid(), content_grid(), header->build(), "_header_grid");
 	}
+
 	grid& p = find_widget<grid>(this, "_header_grid", false);
+
 	for(unsigned i = 0, max = std::max(p.get_cols(), p.get_rows()); i < max; ++i) {
-		if(selectable_item* selectable = find_widget<selectable_item>(&p, "sort_" +  std::to_string(i), false, false)) {
-			selectable->set_callback_state_change(std::bind(&listbox::order_by_column, this, i, _1));
+		//
+		// TODO: I had to change this to case to a toggle_button in order to use a signal handler.
+		// Should probably look into a way to make it more general like it was before (used to be
+		// cast to selectable_item).
+		//
+		// vultraz - 8/23/2017
+		//
+		if(toggle_button* selectable = find_widget<toggle_button>(&p, "sort_" + std::to_string(i), false, false)) {
+			// Register callback to sort the list.
+			connect_signal_notify_modified(*selectable, std::bind(&listbox::order_by_column, this, i, _1));
+
 			if(orders_.size() < max ) {
 				orders_.resize(max);
 			}
+
 			orders_[i].first = selectable;
 		}
 	}
+
 	if(footer) {
 		swap_grid(&get_grid(), content_grid(), footer->build(), "_footer_grid");
 	}
diff --git a/src/gui/widgets/toggle_button.cpp b/src/gui/widgets/toggle_button.cpp
index aae27d53c886..95a2cafa8ace 100644
--- a/src/gui/widgets/toggle_button.cpp
+++ b/src/gui/widgets/toggle_button.cpp
@@ -121,8 +121,6 @@ void toggle_button::set_value(const unsigned selected)
 
 	// Check for get_window() is here to prevent the callback from
 	// being called when the initial value is set.
-	//
-	// TODO: see if this is necessary with the signal handler.
 	if(!get_window()) {
 		return;
 	}
diff --git a/src/scripting/lua_gui2.cpp b/src/scripting/lua_gui2.cpp
index 6e0a412f4614..45bdf7d0a75c 100644
--- a/src/scripting/lua_gui2.cpp
+++ b/src/scripting/lua_gui2.cpp
@@ -780,7 +780,7 @@ int intf_set_dialog_callback(lua_State* L)
 		static dialog_callback_wrapper wrapper;
 		c->connect_click_handler(std::bind(&dialog_callback_wrapper::forward, wrapper, w));
 	} else if(gui2::selectable_item* s = dynamic_cast<gui2::selectable_item*>(w)) {
-		s->set_callback_state_change(&dialog_callback);
+		connect_signal_notify_modified(dynamic_cast<gui2::widget&>(*s), std::bind(dialog_callback, _1));
 	}
 #ifdef GUI2_EXPERIMENTAL_LISTBOX
 	else if(gui2::list_view* l = dynamic_cast<gui2::list_view*>(w)) {