pane.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2012 - 2021
    by Mark de Wever <koraq@xs4all.nl>
    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.
*/

#pragma once

#include "gui/widgets/widget.hpp"
#include "gui/core/window_builder.hpp"
#include "gui/core/placer.hpp"

#include <functional>

#include <list>

namespace gui2
{

// ------------ WIDGET -----------{

namespace implementation
{
struct builder_pane;
} // namespace implementation

class grid;

/**
 * @ingroup GUIWidgetWML
 *
 * A pane is a container where new members can be added and removed during run-time.
 */
class pane : public widget
{
    friend struct pane_implementation;

public:
    struct item
    {

        unsigned id;
        std::map<std::string, std::string> tags;

        grid* item_grid;
    };

    typedef std::function<bool(const item&, const item&)> compare_functor_t;

    typedef std::function<bool(const item&)> filter_functor_t;

private:
    explicit pane(const implementation::builder_pane& builder);

public:
    static pane* build(const implementation::builder_pane& builder);

    /**
     * Creates a new item.
     */
    unsigned create_item(const std::map<std::string, string_map>& item_data,
                         const std::map<std::string, std::string>& tags);

    /** See @ref widget::place. */
    virtual void place(const point& origin, const point& size) override;

    /** See @ref widget::layout_initialize. */
    virtual void layout_initialize(const bool full_initialization) override;

    /** See @ref widget::impl_draw_children. */
    virtual void impl_draw_children(surface& frame_buffer,
                                    int x_offset,
                                    int y_offset) override;

    /** See @ref widget::child_populate_dirty_list. */
    virtual void
    child_populate_dirty_list(window& caller,
                              const std::vector<widget*>& call_stack) override;

    /** See @ref widget::request_reduce_width. */
    virtual void request_reduce_width(const unsigned maximum_width) override;

    /** See @ref widget::find_at. */
    virtual widget* find_at(const point& coordinate,
                             const bool must_be_active) override;

    /** See @ref widget::find_at. */
    virtual const widget* find_at(const point& coordinate,
                                   const bool must_be_active) const override;

    /**
     * Sorts the contents of the pane.
     *
     * @param compare_functor     The functor to use to sort the items.
     */
    void sort(const compare_functor_t& compare_functor);

    /**
     * Filters the contents of the pane.
     *
     * if the @p filter_functor returns @c true the item shown, else it's
     * hidden.
     *
     * @param filter_functor      The functor to determine whether an item
     *                            should be shown or hidden.
     */
    void filter(const filter_functor_t& filter_functor);

private:
    /** See @ref widget::calculate_best_size. */
    virtual point calculate_best_size() const override;

public:
    /** See @ref widget::disable_click_dismiss. */
    bool disable_click_dismiss() const override;

    /** See @ref widget::create_walker. */
    virtual iteration::walker_base* create_walker() override;

    /**
     * Returns a grid in the pane.
     *
     * @param id                  The id of the item whose grid to return. The
     *                            id is the value returned by
     *                            @ref create_item().
     *
     * @returns                   The wanted grid.
     * @retval nullptr               The id isn't associated with an item.
     */
    grid* get_grid(const unsigned id);

    /**
     * Returns a grid in the pane.
     *
     * @param id                  The id of the item whose grid to return. The
     *                            id is the value returned by
     *                            @ref create_item().
     *
     * @returns                   The wanted grid.
     * @retval nullptr               The id isn't associated with an item.
     */
    const grid* get_grid(const unsigned id) const;

private:
    /** The items in the pane. */
    std::list<item> items_;

    /** The builer for the items in the list. */
    builder_grid_ptr item_builder_;

    /** The id generator for the items. */
    unsigned item_id_generator_;

    /** Helper to do the placement. */
    std::unique_ptr<placer_base> placer_;

    /** Places the children on the pane. */
    void place_children();

    /**
     * Moves the children on the pane.
     *
     * After certain operations, e.g. sorting the child widgets need to be
     * placed again. This function does so, but avoids dirtying the widget so
     * redrawing doesn't involve re-rendering the entire widget.
     */
    void set_origin_children();

    /**
     * Places or moves the children on the pane.
     *
     * If the child has its best size it's move else placed.
     *
     * @note It would probably be possible to merge all three placement
     * routines into one and using a flag for what to do: place, set_origin or
     * place_or_set_origin.
     */
    void place_or_set_origin_children();

    /** Updates the placement for the child items. */
    void prepare_placement() const;

    /***** ***** ***** signal handlers ***** ****** *****/

    void signal_handler_request_placement(dispatcher& dispatcher,
                                          const event::ui_event event,
                                          bool& handled);
};

// }---------- BUILDER -----------{

namespace implementation
{

struct builder_pane : public builder_widget
{
    explicit builder_pane(const config& cfg);

    virtual widget* build() const override;

    virtual widget* build(const replacements_map& replacements) const override;

    placer_base::grow_direction grow_direction;

    unsigned parallel_items;

    builder_grid_ptr item_definition;
};

} // namespace implementation

// }------------ END --------------

} // namespace gui2