The Battle for Wesnoth  1.19.1+dev
wml_message.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 
21 #include "gui/widgets/label.hpp"
22 #include "gui/widgets/listbox.hpp"
23 #include "gui/widgets/text_box.hpp"
24 #include "gui/widgets/window.hpp"
25 
26 namespace gui2::dialogs
27 {
28 
29 void wml_message_base::set_input(const std::string& caption,
30  std::string* text,
31  const unsigned maximum_length)
32 {
33  assert(text);
34 
35  has_input_ = true;
36  input_caption_ = caption;
37  input_text_ = text;
38  input_maximum_length_ = maximum_length;
39 }
40 
41 void wml_message_base::set_option_list(const std::vector<wml_message_option>& option_list,
42  int* chosen_option)
43 {
44  assert(!option_list.empty());
45  assert(chosen_option);
46 
47  option_list_ = option_list;
48  chosen_option_ = chosen_option;
49 }
50 
51 /**
52  * @todo This function enables the wml markup for all items, but the interface
53  * is a bit hacky. Especially the fiddling in the internals of the listbox is
54  * ugly. There needs to be a clean interface to set whether a widget has a
55  * markup and what kind of markup. These fixes will be post 1.6.
56  */
58 {
59  window.get_canvas(1).set_variable("portrait_image", wfl::variant(portrait_));
60  window.get_canvas(1).set_variable("portrait_mirror", wfl::variant(mirror_));
61 
62  // Set the markup
63  label& title = find_widget<label>(&window, "title", false);
64  title.set_label(title_);
65  title.set_use_markup(true);
66  title.set_can_wrap(true);
67 
68  styled_widget& message = find_widget<styled_widget>(&window, "message", false);
70  message.set_use_markup(true);
71  // The message label might not always be a scroll_label but the capturing
72  // shouldn't hurt.
74 
75  // Find the input box related fields.
76  label& caption = find_widget<label>(&window, "input_caption", false);
77  text_box& input = find_widget<text_box>(&window, "input", true);
78 
79  if(has_input_) {
80  caption.set_label(input_caption_);
81  caption.set_use_markup(true);
82  input.set_value(*input_text_);
84  window.keyboard_capture(&input);
87  } else {
90  }
91 
92  // Find the option list related fields.
93  listbox& options = find_widget<listbox>(&window, "input_list", true);
94 
95  if(!option_list_.empty()) {
97  for(const wml_message_option& item : option_list_) {
98  // Add the data.
99  data["icon"]["label"] = item.image();
100  data["label"]["label"] = item.label();
101  data["label"]["use_markup"] = "true";
102  data["description"]["label"] = item.description();
103  data["description"]["use_markup"] = "true";
104  options.add_row(data);
105  }
106 
107  // Avoid negative and 0 since item 0 is already selected.
108  if(*chosen_option_ > 0 && static_cast<std::size_t>(*chosen_option_)
109  < option_list_.size()) {
110 
111  options.select_row(*chosen_option_);
112  }
113 
114  if(!has_input_) {
115  window.keyboard_capture(&options);
116  window.set_click_dismiss(false);
118  } else {
119  window.add_to_keyboard_chain(&options);
120  // click_dismiss has been disabled due to the input.
121  }
122  } else {
124  }
126 }
127 
129 {
130  if(has_input_) {
131  *input_text_
132  = find_widget<text_box>(&window, "input", true).get_value();
133  }
134 
135  if(!option_list_.empty()) {
136  *chosen_option_ = find_widget<listbox>(&window, "input_list", true)
137  .get_selected_row();
138  }
139 }
140 
142 {
144  window.get_canvas(1).set_variable("second_portrait_image", wfl::variant(second_portrait_));
145  window.get_canvas(1).set_variable("second_portrait_mirror", wfl::variant(second_mirror_));
146 }
147 
149 
151 
153 
154 int show_wml_message(const std::string& title,
155  const std::string& message,
156  const wml_message_portrait* left,
157  const wml_message_portrait* right,
158  const wml_message_options& options,
159  const wml_message_input& input)
160 {
161  std::shared_ptr<wml_message_base> dlg;
162  if(left && !right) {
163  dlg.reset(new wml_message_left(title, message, left->portrait, left->mirror));
164  } else if(!left && right) {
165  dlg.reset(new wml_message_right(title, message, right->portrait, right->mirror));
166  } else if(right && left) {
167  dlg.reset(new wml_message_double(title, message, left->portrait, left->mirror, right->portrait, right->mirror));
168  }
169  assert(dlg.get());
170 
171  if(input.text_input_was_specified) {
172  dlg->set_input(input.caption, &input.text, input.maximum_length);
173  }
174 
175  if(!options.option_list.empty()) {
176  dlg->set_option_list(options.option_list, &options.chosen_option);
177  }
178 
179  dlg->show();
180  return dlg->get_retval();
181 }
182 
183 } // namespace dialogs
void set_variable(const std::string &key, wfl::variant &&value)
Definition: canvas.hpp:154
Main class to show messages to the user.
Definition: message.hpp:36
std::string * input_text_
The text input.
std::string portrait_
Filename of the portrait.
std::string message_
The message to show to the user.
void set_input(const std::string &caption, std::string *text, const unsigned maximum_length)
Sets the input text variables.
Definition: wml_message.cpp:29
bool has_input_
Do we need to show an input box?
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
unsigned input_maximum_length_
The maximum length of the input text.
bool mirror_
Mirror the portrait?
int * chosen_option_
The chosen option.
std::string input_caption_
The caption to show for the input text.
void set_option_list(const std::vector< wml_message_option > &option_list, int *chosen_option)
Sets the option list.
Definition: wml_message.cpp:41
std::string title_
The title for the dialog.
Definition: wml_message.hpp:93
std::vector< wml_message_option > option_list_
The list of options the user can choose.
virtual void pre_show(window &window) override
Definition: wml_message.cpp:57
Shows a dialog with two portraits, one on each side.
virtual void pre_show(window &window) override
Shows a dialog with the portrait on the left side.
Helper class for message options.
Definition: wml_message.hpp:26
Shows a dialog with the portrait on the right side.
void set_can_wrap(const bool wrap)
Definition: label.hpp:94
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
bool select_row(const unsigned row, const bool select=true)
Selects a row.
Definition: listbox.cpp:243
virtual void set_label(const t_string &text)
canvas & get_canvas(const unsigned index)
virtual void set_use_markup(bool use_markup)
virtual void set_value(const std::string &text)
The set_value is virtual for the password_box class.
void set_maximum_length(const std::size_t maximum_length)
A widget that allows the user to input text in single line.
Definition: text_box.hpp:125
void set_visible(const visibility visible)
Definition: widget.cpp:469
@ invisible
The user set the widget invisible, that means:
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:61
void keyboard_capture(widget *widget)
Definition: window.cpp:1221
void add_to_keyboard_chain(widget *widget)
Adds the widget to the keyboard chain.
Definition: window.cpp:1227
void set_escape_disabled(const bool escape_disabled)
Disable the escape key.
Definition: window.hpp:338
void set_click_dismiss(const bool click_dismiss)
Definition: window.hpp:414
This file contains the window object, this object is a top level container which has the event manage...
int show_wml_message(const std::string &title, const std::string &message, const wml_message_portrait *left, const wml_message_portrait *right, const wml_message_options &options, const wml_message_input &input)
Helper function to show a portrait.
REGISTER_DIALOG(editor_edit_unit)
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:34
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:410
std::string_view data
Definition: picture.cpp:194
Parameter pack for message text input options.
Parameter pack for message list input options.
Parameter pack for message portrait.