scroll_text.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2023 - 2025
    by Subhraman Sarkar (babaissarkar) <sbmskmm@protonmail.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/widgets/scroll_text.hpp"
 
#include "gui/widgets/multiline_text.hpp"
#include "gui/core/window_builder/helper.hpp"
#include "gui/core/register_widget.hpp"
#include "gui/widgets/scrollbar.hpp"
#include "gettext.hpp"
#include "wml_exception.hpp"
 
#include <functional>
 
#define LOG_SCOPE_HEADER get_control_type() + " [" + id() + "] " + __func__
#define LOG_HEADER LOG_SCOPE_HEADER + ':'
 
namespace gui2
{
 
// ------------ WIDGET -----------{
 
REGISTER_WIDGET(scroll_text)
 
scroll_text::scroll_text(const implementation::builder_scroll_text& builder)
    : scrollbar_container(builder, type())
    , state_(ENABLED)
    , wrap_on_(false)
    , text_alignment_(builder.text_alignment)
    , editable_(builder.editable)
    , max_size_(point(0,0))
    , link_aware_(builder.link_aware)
{
    connect_signal<event::LEFT_BUTTON_DOWN>(
        std::bind(&scroll_text::signal_handler_left_button_down, this, std::placeholders::_2),
        event::dispatcher::back_pre_child);
}
 
multiline_text* scroll_text::get_internal_text_box()
{
    if(content_grid()) {
        return dynamic_cast<multiline_text*>(content_grid()->find("_text", false));
    }
 
    return nullptr;
}
 
void scroll_text::set_label(const t_string& label)
{
    if(multiline_text* widget = get_internal_text_box()) {
        widget->set_value(label);
        widget->set_label(label);
 
        bool resize_needed = !content_resize_request();
        if(resize_needed && get_size() != point()) {
            place(get_origin(), get_size());
        }
        widget->goto_start_of_data();
    }
}
 
std::string scroll_text::get_value()
{
    if(multiline_text* widget = get_internal_text_box()) {
        return widget->get_value();
    } else {
        return "";
    }
}
 
void scroll_text::set_link_aware(bool l)
{
    link_aware_ = l;
 
    if(multiline_text* widget = get_internal_text_box()) {
        widget->set_link_aware(l);
    }
}
 
void scroll_text::set_text_alignment(const PangoAlignment text_alignment)
{
    // Inherit.
    styled_widget::set_text_alignment(text_alignment);
 
    text_alignment_ = text_alignment;
 
    if(multiline_text* widget = get_internal_text_box()) {
        widget->set_text_alignment(text_alignment_);
    }
}
 
void scroll_text::set_self_active(const bool active)
{
    state_ = active ? ENABLED : DISABLED;
}
 
bool scroll_text::get_active() const
{
    return state_ != DISABLED;
}
 
unsigned scroll_text::get_state() const
{
    return state_;
}
 
void scroll_text::finalize_subclass()
{
    multiline_text* text = get_internal_text_box();
    assert(text);
 
    text->set_editable(is_editable());
    text->set_label(get_label());
    text->set_text_alignment(text_alignment_);
    text->set_link_aware(link_aware_);
    text->set_use_markup(get_use_markup());
}
 
void scroll_text::place(const point& origin, const point& size) {
    scrollbar_container::place(origin, size);
 
    if(multiline_text* widget = get_internal_text_box()) {
        const rect& visible_area = content_visible_area();
 
        if (widget->get_cursor_pos().x < visible_area.w/2.0) {
            scroll_horizontal_scrollbar(scrollbar_base::BEGIN);
        } else {
            scroll_horizontal_scrollbar_by(widget->get_cursor_pos().x - visible_area.w/2.0);
        }
 
        if (widget->get_cursor_pos().y >= (widget->get_text_end_pos().y - visible_area.h/2.0)) {
            if (widget->get_lines_count() > 1) {
                scroll_vertical_scrollbar(scrollbar_base::END);
            } else {
                scroll_vertical_scrollbar(scrollbar_base::BEGIN);
            }
        } else if (widget->get_cursor_pos().y < visible_area.h/2.0) {
            scroll_vertical_scrollbar(scrollbar_base::BEGIN);
        } else {
            scroll_vertical_scrollbar_by(widget->get_cursor_pos().y - visible_area.h/2.0);
        }
 
        if (widget->get_length() == 0) {
            scroll_horizontal_scrollbar(scrollbar_base::BEGIN);
            scroll_vertical_scrollbar(scrollbar_base::BEGIN);
        }
 
        set_max_size(widget->get_config_default_size());
    }
}
 
point scroll_text::calculate_best_size() const
{
    point calc_size = scrollbar_container::calculate_best_size();
 
    if ((calc_size.x > max_size_.x) && (max_size_.x != 0)) {
        calc_size.x = max_size_.x;
    }
 
    if ((calc_size.y > max_size_.y) && (max_size_.y != 0)) {
        calc_size.y = max_size_.y;
    }
 
    return calc_size;
}
 
void scroll_text::set_max_size(point max_size)
{
    // ------ get vertical scrollbar size ------
    const point vertical_scrollbar = get_vertical_scrollbar_grid()->get_visible() == widget::visibility::invisible
        ? point()
        : get_vertical_scrollbar_grid()->get_best_size();
 
    // ------ get horizontal scrollbar size ------
    const point horizontal_scrollbar = get_horizontal_scrollbar_grid()->get_visible() == widget::visibility::invisible
        ? point()
        : get_horizontal_scrollbar_grid()->get_best_size();
 
    // padding = 3
    max_size_ = point(max_size.x + vertical_scrollbar.x + 3, max_size.y + horizontal_scrollbar.y + 3);
}
 
 
 
void scroll_text::set_can_wrap(bool can_wrap)
{
    wrap_on_ = can_wrap;
}
 
bool scroll_text::can_wrap() const
{
    return true;
}
 
void scroll_text::signal_handler_left_button_down(const event::ui_event event)
{
    DBG_GUI_E << LOG_HEADER << ' ' << event << ".";
 
    get_window()->keyboard_capture(this);
}
 
// }---------- DEFINITION ---------{
 
scroll_text_definition::scroll_text_definition(const config& cfg)
    : styled_widget_definition(cfg)
{
    DBG_GUI_P << "Parsing scroll text " << id;
 
    load_resolutions<resolution>(cfg);
}
 
scroll_text_definition::resolution::resolution(const config& cfg)
    : resolution_definition(cfg), grid(nullptr)
{
    // Note the order should be the same as the enum state_t is scroll_text.hpp.
    state.emplace_back(VALIDATE_WML_CHILD(cfg, "state_enabled", missing_mandatory_wml_tag("scroll_text", "state_enabled")));
    state.emplace_back(VALIDATE_WML_CHILD(cfg, "state_disabled", missing_mandatory_wml_tag("scroll_text", "state_disabled")));
 
    auto child = VALIDATE_WML_CHILD(cfg, "grid", missing_mandatory_wml_tag("scroll_text", "grid"));
    grid = std::make_shared<builder_grid>(child);
}
 
// }---------- BUILDER -----------{
 
namespace implementation
{
 
builder_scroll_text::builder_scroll_text(const config& cfg)
    : builder_scrollbar_container(cfg)
    , text_alignment(decode_text_alignment(cfg["text_alignment"]))
    , editable(cfg["editable"].to_bool(true))
    , link_aware(cfg["link_aware"].to_bool(false))
{
    // Scrollbar default to auto. AUTO_VISIBLE_FIRST_RUN doesn't work.
    if (horizontal_scrollbar_mode == scrollbar_container::AUTO_VISIBLE_FIRST_RUN) {
        horizontal_scrollbar_mode = scrollbar_container::AUTO_VISIBLE;
    }
 
    if (vertical_scrollbar_mode == scrollbar_container::AUTO_VISIBLE_FIRST_RUN) {
        vertical_scrollbar_mode = scrollbar_container::AUTO_VISIBLE;
    }
}
 
std::unique_ptr<widget> builder_scroll_text::build() const
{
    auto widget = std::make_unique<scroll_text>(*this);
 
    const auto conf = widget->cast_config_to<scroll_text_definition>();
    assert(conf);
 
    widget->init_grid(*conf->grid);
    widget->finalize_setup();
 
    DBG_GUI_G << "Window builder: placed scroll text '" << id
              << "' with definition '" << definition << "'.";
 
    return widget;
}
 
} // namespace implementation
 
// }------------ END --------------
 
} // namespace gui2