help_browser.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2017 - 2023
    by Charles Dang <exodia339@gmail.com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#define GETTEXT_DOMAIN "wesnoth-lib"
 
#include "gui/dialogs/help_browser.hpp"
 
#include "game_config_manager.hpp"
#include "gui/auxiliary/find_widget.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/image.hpp"
#include "gui/widgets/multi_page.hpp"
#include "gui/widgets/scroll_label.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/tree_view.hpp"
#include "gui/widgets/tree_view_node.hpp"
#include "gui/widgets/window.hpp"
 
#ifdef GUI2_EXPERIMENTAL_LISTBOX
#include "gui/widgets/list.hpp"
#else
#include "gui/widgets/listbox.hpp"
#endif
 
#include "help/help.hpp"
 
namespace gui2::dialogs
{
 
REGISTER_DIALOG(help_browser)
 
help_browser::help_browser()
    : modal_dialog(window_id())
    , initial_topic_("introduction")
    , help_cfg_(game_config_manager::get()->game_config().mandatory_child("help"))
{
}
 
void help_browser::pre_show(window& window)
{
    tree_view& topic_tree = find_widget<tree_view>(&window, "topic_tree", false);
    multi_page& topic_pages = find_widget<multi_page>(&window, "topic_text_pages", false);
 
    connect_signal_notify_modified(topic_tree,
        std::bind(&help_browser::on_topic_select, this));
 
    window.keyboard_capture(&topic_tree);
 
    unsigned id = 0;
 
    for(const auto& topic : help_cfg_.child_range("topic")) {
        widget_data data;
        widget_item item;
 
        item["label"] = topic["title"];
        data.emplace("topic_name", item);
 
        topic_tree.add_node("topic", data).set_id(std::to_string(id));
 
        // FIXME: maybe using a multi page isn't a good idea here... :| it causes massive lag when opening.
        item.clear();
        data.clear();
 
        item["label"] = topic["text"].empty() ? "" : topic["text"].str();
        data.emplace("topic_text", item);
 
        topic_pages.add_page(data);
 
        ++id;
    }
 
    on_topic_select();
}
 
void help_browser::on_topic_select()
{
    tree_view& tree = find_widget<tree_view>(get_window(), "topic_tree", false);
 
    if(tree.empty()) {
        return;
    }
 
    assert(tree.selected_item());
 
    if(tree.selected_item()->id().empty()) {
        return;
    }
 
    const unsigned topic_i = lexical_cast<unsigned>(tree.selected_item()->id());
    find_widget<multi_page>(get_window(), "topic_text_pages", false).select_page(topic_i);
 
}
 
} // namespace dialogs