The Battle for Wesnoth  1.17.10+dev
help_browser.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2017 - 2022
3  by Charles Dang <exodia339@gmail.com>
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 
20 #include "game_config_manager.hpp"
22 #include "gui/widgets/button.hpp"
23 #include "gui/widgets/image.hpp"
26 #include "gui/widgets/settings.hpp"
27 #include "gui/widgets/settings.hpp"
28 #include "gui/widgets/text_box.hpp"
31 #include "gui/widgets/window.hpp"
32 
33 #ifdef GUI2_EXPERIMENTAL_LISTBOX
34 #include "gui/widgets/list.hpp"
35 #else
36 #include "gui/widgets/listbox.hpp"
37 #endif
38 
39 #include "help/help.hpp"
40 
41 namespace gui2::dialogs
42 {
43 
44 REGISTER_DIALOG(help_browser)
45 
47  : modal_dialog(window_id())
48  , initial_topic_("introduction")
49  , help_cfg_(game_config_manager::get()->game_config().child("help"))
50 {
51 }
52 
54 {
55  tree_view& topic_tree = find_widget<tree_view>(&window, "topic_tree", false);
56  multi_page& topic_pages = find_widget<multi_page>(&window, "topic_text_pages", false);
57 
59  std::bind(&help_browser::on_topic_select, this));
60 
61  window.keyboard_capture(&topic_tree);
62 
63  unsigned id = 0;
64 
65  for(const auto& topic : help_cfg_.child_range("topic")) {
68 
69  item["label"] = topic["title"];
70  data.emplace("topic_name", item);
71 
72  topic_tree.add_node("topic", data).set_id(std::to_string(id));
73 
74  // FIXME: maybe using a multi page isn't a good idea here... :| it causes massive lag when opening.
75  item.clear();
76  data.clear();
77 
78  item["label"] = topic["text"].empty() ? "" : topic["text"].str();
79  data.emplace("topic_text", item);
80 
81  topic_pages.add_page(data);
82 
83  ++id;
84  }
85 
87 }
88 
90 {
91  tree_view& tree = find_widget<tree_view>(get_window(), "topic_tree", false);
92 
93  if(tree.empty()) {
94  return;
95  }
96 
97  assert(tree.selected_item());
98 
99  if(tree.selected_item()->id().empty()) {
100  return;
101  }
102 
103  const unsigned topic_i = lexical_cast<unsigned>(tree.selected_item()->id());
104  find_widget<multi_page>(get_window(), "topic_text_pages", false).select_page(topic_i);
105 
106 }
107 
108 } // namespace dialogs
window(const builder_window::window_resolution &definition)
< Needs to be initialized in show.
Definition: window.cpp:263
tree_view_node & add_node(const std::string &id, const widget_data &data, const int index=-1)
Definition: tree_view.cpp:57
const std::string & id() const
Definition: widget.cpp:111
This file contains the window object, this object is a top level container which has the event manage...
child_itors child_range(config_key_type key)
Definition: config.cpp:344
std::string_view data
Definition: picture.cpp:206
tree_view_node * selected_item()
Definition: tree_view.hpp:110
To lexical_cast(From value)
Lexical cast converts one type to another.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
std::map< std::string, t_string > widget_item
Definition: widget.hpp:32
This file contains the settings handling of the widget library.
A tree view is a control that holds several items of the same or different types. ...
Definition: tree_view.hpp:60
window * get_window()
Returns a pointer to the dialog&#39;s window.
Game configuration data as global variables.
Definition: build_info.cpp:60
CURSOR_TYPE get()
Definition: cursor.cpp:216
Help browser dialog.
A multi page is a control that contains several &#39;pages&#39; of which only one is visible.
Definition: multi_page.hpp:49
bool empty() const
Definition: tree_view.cpp:100
void set_id(const std::string &id)
Definition: widget.cpp:99
Abstract base class for all modal dialogs.
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
Definition: help.cpp:57
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66
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
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:414