The Battle for Wesnoth  1.19.0-dev
drop_down_menu.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2024
3  by Mark de Wever <koraq@xs4all.nl>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #define GETTEXT_DOMAIN "wesnoth-lib"
17 
19 
23 #include "gui/widgets/image.hpp"
24 #include "gui/widgets/listbox.hpp"
29 #include "gui/widgets/window.hpp"
30 
31 #include "sdl/rect.hpp"
32 #include <functional>
33 
34 namespace gui2::dialogs
35 {
36 REGISTER_DIALOG(drop_down_menu)
37 
39  : checkbox()
40  , icon(cfg["icon"].str())
41  , image()
42  , label(cfg["label"].t_str())
43  , details()
44  , tooltip(cfg["tooltip"].t_str())
45 {
46  // Checkboxes take precedence in column 1
47  if(cfg.has_attribute("checkbox")) {
48  checkbox = cfg["checkbox"].to_bool(false);
49  }
50 
51  // Images take precedence in column 2
52  if(cfg.has_attribute("image")) {
53  image = cfg["image"].str();
54  }
55 
56  if(cfg.has_attribute("details")) {
57  details = cfg["details"].t_str();
58  }
59 }
60 
61 namespace
62 {
63  void callback_flip_embedded_toggle(window& window)
64  {
65  listbox& list = find_widget<listbox>(&window, "list", true);
66 
67  /* If the currently selected row has a toggle button, toggle it.
68  * Note this cannot be handled in mouse_up_callback since at that point the new row selection has not registered,
69  * meaning the currently selected row's button is toggled.
70  */
71  grid* row_grid = list.get_row_grid(list.get_selected_row());
72  if(toggle_button* checkbox = find_widget<toggle_button>(row_grid, "checkbox", false, false)) {
73  checkbox->set_value_bool(!checkbox->get_value_bool(), true);
74  }
75  }
76 
77  void resize_callback(window& window)
78  {
80  }
81 }
82 
83 drop_down_menu::drop_down_menu(styled_widget* parent, const std::vector<config>& items, int selected_item, bool keep_open)
84  : modal_dialog(window_id())
85  , parent_(parent)
86  , items_(items.begin(), items.end())
87  , button_pos_(parent->get_rectangle())
88  , selected_item_(selected_item)
89  , use_markup_(parent->get_use_markup())
90  , keep_open_(keep_open)
91  , mouse_down_happened_(false)
92 {
93 }
94 
95 drop_down_menu::drop_down_menu(SDL_Rect button_pos, const std::vector<config>& items, int selected_item, bool use_markup, bool keep_open)
96  : modal_dialog(window_id())
97  , parent_(nullptr)
98  , items_(items.begin(), items.end())
99  , button_pos_(button_pos)
100  , selected_item_(selected_item)
101  , use_markup_(use_markup)
102  , keep_open_(keep_open)
103  , mouse_down_happened_(false)
104 {
105 }
106 
108 {
109  if(!mouse_down_happened_) {
110  return;
111  }
112 
113  listbox& list = find_widget<listbox>(get_window(), "list", true);
114 
115  /* Disregard clicks on scrollbars and toggle buttons so the dropdown menu can be scrolled or have an embedded
116  * toggle button selected without the menu closing.
117  *
118  * This works since this mouse_up_callback function is called before widgets' left-button-up handlers.
119  *
120  * Additionally, this is done before row deselection so selecting/deselecting a toggle button doesn't also leave
121  * the list with no row visually selected. Oddly, the visual deselection doesn't seem to cause any crashes, and
122  * the previously selected row is reselected when the menu is opened again. Still, it's odd to see your selection
123  * vanish.
124  */
126  return;
127  }
128 
129  if(dynamic_cast<toggle_button*>(get_window()->find_at(coordinate, true)) != nullptr) {
130  return;
131  }
132 
133  /* FIXME: This dialog uses a listbox with 'has_minimum = false'. This allows a listbox to have 0 or 1 selections,
134  * and selecting the same entry toggles that entry's state (ie, if it was selected, it will be deselected). Because
135  * of this, selecting the same entry in the dropdown list essentially sets the list's selected row to -1, causing problems.
136  *
137  * In order to work around this, we first manually deselect the selected entry here. This handler is called *before*
138  * the listbox's click handler, and as such the selected item will remain toggled on when the click handler fires.
139  */
140  const int sel = list.get_selected_row();
141  if(sel >= 0) {
142  list.select_row(sel, false);
143  }
144 
147  } else if(!keep_open_) {
149  }
150 }
151 
153 {
154  mouse_down_happened_ = true;
155 }
156 
158 {
163 
164  listbox& list = find_widget<listbox>(&window, "list", true);
165 
166  for(const auto& entry : items_) {
169 
170  //
171  // These widgets can be initialized here since they don't require widget type swapping.
172  //
173  item["use_markup"] = utils::bool_string(use_markup_);
174  if(!entry.checkbox) {
175  item["label"] = entry.icon;
176  data.emplace("icon", item);
177  }
178 
179  if(!entry.image) {
180  item["label"] = entry.label;
181  data.emplace("label", item);
182  }
183 
184  if(entry.details) {
185  item["label"] = *entry.details;
186  data.emplace("details", item);
187  }
188 
189  grid& new_row = list.add_row(data);
190  grid& mi_grid = find_widget<grid>(&new_row, "menu_item", false);
191 
192  // Set the tooltip on the whole panel
193  find_widget<toggle_panel>(&new_row, "panel", false).set_tooltip(entry.tooltip);
194 
195  if(entry.checkbox) {
196  auto checkbox = build_single_widget_instance<toggle_button>(config{"definition", "no_label"});
197  checkbox->set_id("checkbox");
198  checkbox->set_value_bool(*entry.checkbox);
199 
200  // Fire a NOTIFIED_MODIFIED event in the parent widget when the toggle state changes
201  if(parent_) {
202  connect_signal_notify_modified(*checkbox, std::bind([this]() {
204  }));
205  }
206 
207  mi_grid.swap_child("icon", std::move(checkbox), false);
208  }
209 
210  if(entry.image) {
211  auto img = build_single_widget_instance<image>();
212  img->set_label(*entry.image);
213 
214  mi_grid.swap_child("label", std::move(img), false);
215  }
216  }
217 
218  if(selected_item_ >= 0 && static_cast<unsigned>(selected_item_) < list.get_item_count()) {
220  }
221 
222  window.keyboard_capture(&list);
223 
224  // Dismiss on clicking outside the window.
226  std::bind(&drop_down_menu::mouse_up_callback, this, std::placeholders::_3, std::placeholders::_4, std::placeholders::_5), event::dispatcher::front_child);
227 
229  std::bind(&drop_down_menu::mouse_up_callback, this, std::placeholders::_3, std::placeholders::_4, std::placeholders::_5), event::dispatcher::front_child);
230 
233 
234  // Dismiss on resize.
236  std::bind(&resize_callback, std::ref(window)), event::dispatcher::front_child);
237 
238  // Handle embedded button toggling.
240  std::bind(&callback_flip_embedded_toggle, std::ref(window)));
241 }
242 
244 {
245  selected_item_ = find_widget<listbox>(&window, "list", true).get_selected_row();
246 }
247 
248 boost::dynamic_bitset<> drop_down_menu::get_toggle_states() const
249 {
250  const listbox& list = find_widget<const listbox>(get_window(), "list", true);
251 
252  boost::dynamic_bitset<> states;
253 
254  for(unsigned i = 0; i < list.get_item_count(); ++i) {
255  const grid* row_grid = list.get_row_grid(i);
256 
257  if(const toggle_button* checkbox = find_widget<const toggle_button>(row_grid, "checkbox", false, false)) {
258  states.push_back(checkbox->get_value_bool());
259  } else {
260  states.push_back(false);
261  }
262  }
263 
264  return states;
265 }
266 
267 } // namespace dialogs
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
Used by the menu_button widget.
std::vector< entry_data > items_
Configuration of each row.
SDL_Rect button_pos_
The screen location of the menu_button button that triggered this droplist.
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
bool keep_open_
Whether to keep this dialog open after a click occurs not handled by special exceptions such as scrol...
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
void mouse_up_callback(bool &, bool &, const point &coordinate)
drop_down_menu(styled_widget *parent, const std::vector< config > &items, int selected_item, bool keep_open)
Menu was invoked from a widget (currently a [multi]menu_button).
boost::dynamic_bitset get_toggle_states() const
If a toggle button widget is present, returns the toggled state of each row's button.
bool mouse_down_happened_
When menu is invoked on a long-touch timer, a following mouse-up event will close it.
styled_widget * parent_
The widget that invoked this dialog, if applicable.
Abstract base class for all modal dialogs.
window * get_window()
Returns a pointer to the dialog's window.
Class to show the tips.
Definition: tooltip.cpp:56
void connect_signal(const F &func, const queue_position position=back_child)
Adds a callback to the appropriate queue based on event type.
Definition: dispatcher.hpp:351
bool fire(const ui_event event, widget &target)
Fires an event which has no extra parameters.
Definition: dispatcher.cpp:74
Base container class.
Definition: grid.hpp:32
std::unique_ptr< widget > swap_child(const std::string &id, std::unique_ptr< widget > w, const bool recurse, widget *new_parent=nullptr)
Exchanges a child in the grid.
Definition: grid.cpp:101
A label displays text that can be wrapped but no scrollbars are provided.
Definition: label.hpp:56
The listbox class.
Definition: listbox.hpp:43
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:59
const grid * get_row_grid(const unsigned row) const
Returns the grid of the wanted row.
Definition: listbox.cpp:230
bool select_row(const unsigned row, const bool select=true)
Selects a row.
Definition: listbox.cpp:243
int get_selected_row() const
Returns the first selected row.
Definition: listbox.cpp:268
unsigned get_item_count() const
Returns the number of items in the listbox.
Definition: listbox.cpp:124
virtual unsigned get_state() const override
See styled_widget::get_state.
Definition: scrollbar.cpp:147
scrollbar_base * vertical_scrollbar()
Base class for all visible items.
Class for a toggle button.
rect get_rectangle() const
Gets the bounding rectangle of the widget on the screen.
Definition: widget.cpp:312
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:63
void set_retval(const int retval, const bool close_window=true)
Sets there return value of the window.
Definition: window.hpp:399
void keyboard_capture(widget *widget)
Definition: window.cpp:1215
void set_variable(const std::string &key, const wfl::variant &value)
Definition: window.hpp:426
virtual widget * find_at(const point &coordinate, const bool must_be_active) override
See widget::find_at.
Definition: window.cpp:773
std::size_t i
Definition: function.cpp:968
This file contains the window object, this object is a top level container which has the event manage...
REGISTER_DIALOG(tod_new_schedule)
@ NOTIFY_MODIFIED
Definition: handler.hpp:158
@ SDL_LEFT_BUTTON_DOWN
Definition: handler.hpp:136
@ SDL_VIDEO_RESIZE
Definition: handler.hpp:133
@ SDL_LEFT_BUTTON_UP
Definition: handler.hpp:137
@ SDL_RIGHT_BUTTON_UP
Definition: handler.hpp:141
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:203
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:34
std::map< std::string, t_string > widget_item
Definition: widget.hpp:31
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
@ CANCEL
Dialog was closed with the CANCEL button.
Definition: retval.hpp:38
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:412
Functions to load and save images from/to disk.
const std::vector< std::string > items
map_location coordinate
Contains an x and y coordinate used for starting positions in maps.
bool contains(const Container &container, const Value &value)
Returns true iff value is found in container.
Definition: general.hpp:83
std::string bool_string(const bool value)
Converts a bool value to 'true' or 'false'.
std::string_view data
Definition: picture.cpp:194
Contains the SDL_Rect helper code.
Holds a 2D point.
Definition: point.hpp:25