The Battle for Wesnoth  1.17.12+dev
label_settings.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2022
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 
19 #include "display.hpp"
20 #include "font/text_formatting.hpp"
21 #include "formatter.hpp"
22 #include "formula/string_utils.hpp"
23 #include "gettext.hpp"
25 #include "gui/widgets/label.hpp"
26 #include "gui/widgets/listbox.hpp"
27 #include "gui/widgets/settings.hpp"
30 #include "gui/widgets/window.hpp"
31 #include "map/label.hpp"
32 #include "team.hpp"
33 
34 #include <vector>
35 
36 namespace gui2::dialogs
37 {
38 REGISTER_DIALOG(label_settings)
39 
41  : modal_dialog(window_id())
42  , viewer_(dc)
43 {
44  const std::vector<std::string>& all_categories = display::get_singleton()->labels().all_categories();
45  const std::vector<std::string>& hidden_categories = viewer_.hidden_label_categories();
46 
47  for(const std::string& cat : all_categories) {
48  all_labels_[cat] = true;
49 
50  // TODO: Translatable names for categories?
51  if(cat.substr(0, 4) == "cat:") {
52  labels_display_[cat] = cat.substr(4);
53  } else if(cat == "team") {
54  labels_display_[cat] = _("Team Labels");
55  }
56  }
57 
58  for(const std::string& hidden_cat : hidden_categories) {
59  all_labels_[hidden_cat] = false;
60  }
61 
62  for(std::size_t i = 0; i < viewer_.teams().size(); i++) {
63  const team& team = viewer_.teams()[i];
64  const std::string label_cat_key = "side:" + std::to_string(i + 1);
65 
66  if(team.hidden()) {
67  labels_display_[label_cat_key] = "";
68  continue;
69 
70  }
71 
72  std::string team_name = team.side_name();
73  if(team_name.empty()) {
74  team_name = team.user_team_name();
75  }
76 
77  if(team_name.empty()) {
78  team_name = _("Unknown");
79  }
80 
81  utils::string_map subst;
82  subst["side_number"] = std::to_string(i + 1);
83  subst["name"] = team_name;
84  labels_display_[label_cat_key] = VGETTEXT("Side $side_number ($name)", subst);
85  }
86 }
87 
89 {
90  listbox& cats_listbox = find_widget<listbox>(&window, "label_types", false);
91  widget_data list_data;
92 
93  for(const auto& label_entry : all_labels_) {
94  const std::string& category = label_entry.first;
95  const bool visible = label_entry.second;
96 
97  std::string name = labels_display_[category];
98  if(category.substr(0, 5) == "side:") {
99  // This means it's a hidden side, so don't show it.
100  if(name.empty()) {
101  continue;
102  }
103 
104  const int team = std::stoi(category.substr(5)) - 1;
105  const color_t tc = game_config::tc_info(viewer_.teams()[team].color())[0];
106 
107  name = (formatter() << font::span_color(tc) << name << "</span>").str();
108  }
109 
110  list_data["cat_name"]["label"] = name;
111  grid* grid = &cats_listbox.add_row(list_data);
112 
113  toggle_button& status = find_widget<toggle_button>(grid, "cat_status", false);
114  status.set_value(visible);
115 
116  connect_signal_notify_modified(status, std::bind(&label_settings::toggle_category, this, std::placeholders::_1, category));
117 
118  if(category.substr(0, 5) == "side:") {
119  label& cat_name = find_widget<label>(grid, "cat_name", false);
120  cat_name.set_use_markup(true);
121  }
122  }
123 }
124 
126 {
127  if(get_retval() == retval::OK) {
128  std::vector<std::string> hidden_categories;
129 
130  for(const auto& lbl : all_labels_) {
131  if(lbl.second == false) {
132  hidden_categories.push_back(lbl.first);
133  }
134  }
135 
136  viewer_.hidden_label_categories().swap(hidden_categories);
137  }
138 }
139 
140 void label_settings::toggle_category(widget& box, const std::string& category)
141 {
142  all_labels_[category] = static_cast<toggle_button&>(box).get_value_bool();
143 }
144 
145 } // namespace dialogs
window(const builder_window::window_resolution &definition)
< Needs to be initialized in show.
Definition: window.cpp:263
static display * get_singleton()
Returns the display object if a display object exists.
Definition: display.hpp:98
virtual void set_value(unsigned selected, bool fire_event=false) override
Inherited from selectable_item.
std::map< std::string, t_string > string_map
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
void toggle_category(widget &box, const std::string &category)
Callback for toggling a checkbox state.
const std::vector< std::string > & all_categories() const
Definition: label.cpp:287
const std::string & side_name() const
Definition: team.hpp:295
This file contains the window object, this object is a top level container which has the event manage...
Base class for all widgets.
Definition: widget.hpp:53
grid & add_row(const widget_item &item, const int index=-1)
When an item in the list is selected by the user we need to update the state.
Definition: listbox.cpp:61
A label displays a text, the text can be wrapped but no scrollbars are provided.
Definition: label.hpp:57
static std::string _(const char *str)
Definition: gettext.hpp:93
status
The status of the window.
Definition: window.hpp:169
The listbox class.
Definition: listbox.hpp:45
std::string span_color(const color_t &color)
Returns a Pango formatting string using the provided color_t object.
Base container class.
Definition: grid.hpp:31
This class stores all the data for a single &#39;side&#39; (in game nomenclature).
Definition: team.hpp:75
This file contains the settings handling of the widget library.
std::ostringstream wrapper.
Definition: formatter.hpp:39
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:58
virtual void set_use_markup(bool use_markup)
map_display and display: classes which take care of displaying the map and game-data on the screen...
bool hidden() const
Definition: team.hpp:335
std::map< std::string, bool > all_labels_
The execute function.
std::size_t i
Definition: function.cpp:968
virtual const std::vector< team > & teams() const =0
#define VGETTEXT(msgid,...)
Handy wrappers around interpolate_variables_into_string and gettext.
bool grid()
Definition: general.cpp:565
int get_retval() const
Returns the cached window exit code.
Abstract base class for all modal dialogs.
const std::vector< color_t > & tc_info(const std::string &name)
std::map< std::string, t_string > labels_display_
map_labels & labels()
Definition: display.cpp:2619
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
Dialog was closed with the OK button.
Definition: retval.hpp:35
virtual const std::vector< std::string > & hidden_label_categories() const =0
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66
Class for a toggle button.
const t_string & user_team_name() const
Definition: team.hpp:285
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:205