container.cpp

Go to the documentation of this file.

/*
   Copyright (C) 2008 - 2016 by Mark de Wever <[email protected]>
   Part of the Battle for Wesnoth Project http://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/container.hpp"

#include "gui/core/log.hpp"

#define LOG_SCOPE_HEADER                                                       \
    "tcontainer(" + get_control_type() + ") [" + id() + "] " + __func__
#define LOG_HEADER LOG_SCOPE_HEADER + ':'

namespace gui2
{

SDL_Rect tcontainer_::get_client_rect() const
{
    return get_rectangle();
}

void tcontainer_::layout_initialise(const bool full_initialisation)
{
    // Inherited.
    tcontrol::layout_initialise(full_initialisation);

    grid_.layout_initialise(full_initialisation);
}

void tcontainer_::reduce_width(const unsigned maximum_width)
{
    grid_.reduce_width(maximum_width - border_space().x);
}

void tcontainer_::request_reduce_width(const unsigned maximum_width)
{
    grid_.request_reduce_width(maximum_width - border_space().x);
}

void tcontainer_::demand_reduce_width(const unsigned maximum_width)
{
    grid_.demand_reduce_width(maximum_width - border_space().x);
}

void tcontainer_::reduce_height(const unsigned maximum_height)
{
    grid_.reduce_height(maximum_height - border_space().y);
}

void tcontainer_::request_reduce_height(const unsigned maximum_height)
{
    grid_.request_reduce_height(maximum_height - border_space().y);
}

void tcontainer_::demand_reduce_height(const unsigned maximum_height)
{
    grid_.demand_reduce_height(maximum_height - border_space().y);
}

bool tcontainer_::can_wrap() const
{
    return grid_.can_wrap() || twidget::can_wrap();
}

void tcontainer_::place(const tpoint& origin, const tpoint& size)
{
    tcontrol::place(origin, size);

    const SDL_Rect rect = get_client_rect();
    const tpoint client_size(rect.w, rect.h);
    const tpoint client_position(rect.x, rect.y);
    grid_.place(client_position, client_size);
}

bool tcontainer_::has_widget(const twidget& widget) const
{
    return twidget::has_widget(widget) || grid_.has_widget(widget);
}

tpoint tcontainer_::calculate_best_size() const
{
    log_scope2(log_gui_layout, LOG_SCOPE_HEADER);

    tpoint result(grid_.get_best_size());
    const tpoint border_size = border_space();
    const tpoint minimum_size = get_config_minimum_size();

    // If the best size has a value of 0 it's means no limit so don't
    // add the border_size might set a very small best size.
    if(result.x) {
        result.x += border_size.x;
    }
    if(minimum_size.x != 0 && result.x < minimum_size.x) {
        result.x = minimum_size.x;
    }

    if(result.y) {
        result.y += border_size.y;
    }
    if(minimum_size.y != 0 && result.y < minimum_size.y) {
        result.y = minimum_size.y;
    }


    DBG_GUI_L << LOG_HEADER << " border size " << border_size << " returning "
              << result << ".\n";

    return result;
}

void tcontainer_::set_origin(const tpoint& origin)
{
    // Inherited.
    twidget::set_origin(origin);

    const SDL_Rect rect = get_client_rect();
    const tpoint client_position(rect.x, rect.y);
    grid_.set_origin(client_position);
}

void tcontainer_::set_visible_rectangle(const SDL_Rect& rectangle)
{
    // Inherited.
    twidget::set_visible_rectangle(rectangle);

    grid_.set_visible_rectangle(rectangle);
}

void tcontainer_::impl_draw_children(surface& frame_buffer,
                                     int x_offset,
                                     int y_offset)
{
    assert(get_visible() == twidget::tvisible::visible
           && grid_.get_visible() == twidget::tvisible::visible);

    grid_.draw_children(frame_buffer, x_offset, y_offset);
}

void tcontainer_::layout_children()
{
    grid_.layout_children();
}

void
tcontainer_::child_populate_dirty_list(twindow& caller,
                                       const std::vector<twidget*>& call_stack)
{
    std::vector<twidget*> child_call_stack = call_stack;
    grid_.populate_dirty_list(caller, child_call_stack);
}

twidget* tcontainer_::find_at(const tpoint& coordinate,
                              const bool must_be_active)
{
    return grid_.find_at(coordinate, must_be_active);
}

const twidget* tcontainer_::find_at(const tpoint& coordinate,
                                    const bool must_be_active) const
{
    return grid_.find_at(coordinate, must_be_active);
}

twidget* tcontainer_::find(const std::string& id, const bool must_be_active)
{
    twidget* result = tcontrol::find(id, must_be_active);
    return result ? result : grid_.find(id, must_be_active);
}

const twidget* tcontainer_::find(const std::string& id,
                                 const bool must_be_active) const
{
    const twidget* result = tcontrol::find(id, must_be_active);
    return result ? result : grid_.find(id, must_be_active);
}

void tcontainer_::set_active(const bool active)
{
    // Not all our children might have the proper state so let them run
    // unconditionally.
    grid_.set_active(active);

    if(active == get_active()) {
        return;
    }

    set_is_dirty(true);

    set_self_active(active);
}

bool tcontainer_::disable_click_dismiss() const
{
    return tcontrol::disable_click_dismiss() && grid_.disable_click_dismiss();
}

void
tcontainer_::init_grid(const boost::intrusive_ptr<tbuilder_grid>& grid_builder)
{
    log_scope2(log_gui_general, LOG_SCOPE_HEADER);

    assert(initial_grid().get_rows() == 0 && initial_grid().get_cols() == 0);

    grid_builder->build(&initial_grid());
}

tpoint tcontainer_::border_space() const
{
    return tpoint(0, 0);
}

} // namespace gui2