The Battle for Wesnoth  1.17.17+dev
select_orb_colors.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2023
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #define GETTEXT_DOMAIN "wesnoth-lib"
16 
18 
22 #include "gui/widgets/button.hpp"
23 #include "gui/widgets/grid.hpp"
24 #include "gui/widgets/settings.hpp"
26 #include "gui/widgets/window.hpp"
27 
28 #include "game_config.hpp"
29 #include "preferences/general.hpp"
30 #include <functional>
31 
32 namespace gui2::dialogs
33 {
34 namespace
35 {
36 std::string get_orb_widget_prefix(const std::string& base_id)
37 {
38  return "orb_" + base_id + "_";
39 }
40 
41 } // namespace
42 
43 REGISTER_DIALOG(select_orb_colors)
44 
46  : modal_dialog(window_id())
47  , show_unmoved_(preferences::show_unmoved_orb())
48  , show_partial_(preferences::show_partial_orb())
49  , show_disengaged_(preferences::show_disengaged_orb())
50  , show_moved_(preferences::show_moved_orb())
51  , show_ally_(preferences::show_ally_orb())
52  , two_color_ally_(preferences::show_status_on_ally_orb())
53  , show_enemy_(preferences::show_enemy_orb())
54 {
55 }
56 
58 {
64 
66  find_widget<button>(&window, "orb_defaults", false), std::bind(&select_orb_colors::reset_orb_callback, this));
67 }
68 
70 {
71  if(get_retval() != retval::OK) {
72  return;
73  }
74 
82 
83  preferences::set_unmoved_color(groups_["unmoved"].get_active_member_value());
84  preferences::set_partial_color(groups_["partial"].get_active_member_value());
85  preferences::set_moved_color(groups_["moved"].get_active_member_value());
86  preferences::set_allied_color(groups_["ally"].get_active_member_value());
87  preferences::set_enemy_color(groups_["enemy"].get_active_member_value());
88 }
89 
90 void select_orb_colors::setup_orb_toggle(const std::string& base_id, bool& shown)
91 {
92  const std::string prefix = get_orb_widget_prefix(base_id);
93  toggle_button& toggle = find_widget<toggle_button>(get_window(), prefix + "show", false);
94  toggle.set_value_bool(shown);
95 
96  connect_signal_mouse_left_click(toggle, std::bind(&select_orb_colors::toggle_orb_callback, this, std::ref(shown)));
97 }
98 
99 void select_orb_colors::setup_orb_group(const std::string& base_id, bool& shown, const std::string& initial)
100 {
101  setup_orb_toggle(base_id, shown);
102 
103  //
104  // Set up the toggle group.
105  //
106  group<std::string>& group = groups_[base_id];
107 
108  // Grid containing each color option toggle.
109  const std::string prefix = get_orb_widget_prefix(base_id);
110  grid& selection = find_widget<grid>(get_window(), prefix + "selection", false);
111 
112  for(iteration::bottom_up_iterator<true, false, true> iter(selection); !iter.at_end(); ++iter) {
113  if(toggle_button* button = dynamic_cast<toggle_button*>(iter.get())) {
114  const std::string& id = button->id();
115  group.add_member(button, id.substr(prefix.size()));
116  }
117  }
118 
119  group.set_member_states(initial);
120 }
121 
122 void select_orb_colors::setup_orb_group_two_color(const std::string& base_id, bool& shown, bool& two_color, const std::string& initial)
123 {
124  setup_orb_group(base_id, shown, initial);
125 
126  const std::string prefix = get_orb_widget_prefix(base_id);
127  toggle_button& toggle = find_widget<toggle_button>(get_window(), prefix + "two_color", false);
128  toggle.set_value_bool(two_color);
129 
130  connect_signal_mouse_left_click(toggle, std::bind(&select_orb_colors::toggle_orb_callback, this, std::ref(two_color)));
131 }
132 
133 void select_orb_colors::reset_orb_toggle(const std::string& base_id, bool shown)
134 {
135  const std::string prefix = get_orb_widget_prefix(base_id);
136 
137  toggle_button& toggle = find_widget<toggle_button>(get_window(), prefix + "show", false);
138  toggle.set_value_bool(shown);
139 }
140 
141 void select_orb_colors::reset_orb_group(const std::string& base_id, bool shown, const std::string& initial)
142 {
143  reset_orb_toggle(base_id, shown);
144  groups_[base_id].set_member_states(initial);
145 }
146 
147 void select_orb_colors::reset_orb_group_two_color(const std::string& base_id, bool shown, bool two_color, const std::string& initial)
148 {
149  reset_orb_group(base_id, shown, initial);
150 
151  const std::string prefix = get_orb_widget_prefix(base_id);
152 
153  toggle_button& toggle = find_widget<toggle_button>(get_window(), prefix + "two_color", false);
154  toggle.set_value_bool(two_color);
155 }
156 
158 {
159  // The code for the two-color groups uses this for both the main setting and the two_color setting - if
160  // you add any extra logic here, check that it's still also applicable to the two_color setting.
161  storage = !storage;
162 }
163 
165 {
173 
179 }
180 
181 } // namespace dialogs
Simple push button.
Definition: button.hpp:37
Abstract base class for all modal dialogs.
int get_retval() const
Returns the cached window exit code.
window * get_window()
Returns a pointer to the dialog's window.
void setup_orb_toggle(const std::string &base_id, bool &shown)
The display function.
void reset_orb_group(const std::string &base_id, bool shown, const std::string &initial)
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
void setup_orb_group(const std::string &base_id, bool &shown, const std::string &initial)
Sets up the checkbox and row of color buttons for the one-color options, including connecting the cal...
void setup_orb_group_two_color(const std::string &base_id, bool &shown, bool &two_color, const std::string &initial)
Sets up two checkboxes and a row of color buttons.
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
void reset_orb_group_two_color(const std::string &base_id, bool shown, bool two_color, const std::string &initial)
std::map< std::string, group< std::string > > groups_
void reset_orb_toggle(const std::string &base_id, bool shown)
Change the UI's ticked/unticked state.
Base container class.
Definition: grid.hpp:32
void add_member(selectable_item *w, const T &value)
Adds a widget/value pair to the group map.
Definition: group.hpp:42
void set_member_states(const T &value)
Sets the toggle values for all widgets besides the one associated with the specified value to false.
Definition: group.hpp:111
The iterator class.
Definition: iterator.hpp:37
bool at_end() const
Has the iterator reached the end?
Definition: iterator.hpp:58
void set_value_bool(bool value, bool fire_event=false)
Class for a toggle button.
const std::string & id() const
Definition: widget.cpp:111
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:67
This file contains the window object, this object is a top level container which has the event manage...
Contains the base iterator class for the gui2 widgets.
#define REGISTER_DIALOG(window_id)
Wrapper for REGISTER_DIALOG2.
std::string partial_orb_color
std::string moved_orb_color
std::string unmoved_orb_color
std::string ally_orb_color
std::string enemy_orb_color
bool show_status_on_ally_orb
bool show_moved_orb
bool show_ally_orb
bool show_disengaged_orb
bool show_partial_orb
bool show_enemy_orb
bool show_unmoved_orb
void connect_signal_mouse_left_click(dispatcher &dispatcher, const signal &signal)
Connects a signal handler for a left mouse button click.
Definition: dispatcher.cpp:179
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
Modify, read and display user preferences.
void set_show_disengaged_orb(bool show_orb)
Definition: general.cpp:307
void set_allied_color(const std::string &color_id)
Definition: general.cpp:328
void set_show_partial_orb(bool show_orb)
Definition: general.cpp:300
void set_show_enemy_orb(bool show_orb)
Definition: general.cpp:279
std::string moved_color()
Definition: general.cpp:352
void set_unmoved_color(const std::string &color_id)
Definition: general.cpp:368
std::string partial_color()
Definition: general.cpp:372
void set_show_ally_orb(bool show_orb)
Definition: general.cpp:265
std::string enemy_color()
Definition: general.cpp:342
std::string allied_color()
Definition: general.cpp:322
std::string unmoved_color()
Definition: general.cpp:362
void set_enemy_color(const std::string &color_id)
Definition: general.cpp:348
void set_moved_color(const std::string &color_id)
Definition: general.cpp:358
void set_show_status_on_ally_orb(bool show_orb)
Definition: general.cpp:272
void set_show_moved_orb(bool show_orb)
Definition: general.cpp:286
void set_show_unmoved_orb(bool show_orb)
Definition: general.cpp:293
void set_partial_color(const std::string &color_id)
Definition: general.cpp:378
This file contains the settings handling of the widget library.