scrollbar_container.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 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/core/notifiee.hpp"
#include "gui/widgets/container_base.hpp"
#include "gui/widgets/scrollbar.hpp"

namespace gui2
{
class spacer;

namespace implementation
{
struct builder_scroll_label;
struct builder_scrollbar_panel;
struct builder_styled_widget;
}

/**
 * Base class for creating containers with one or two scrollbar(s).
 *
 * For now users can't instantiate this class directly and needs to use small
 * wrapper classes. Maybe in the future users can use the class directly.
 *
 * @todo events are not yet send to the content grid.
 */
class scrollbar_container : public container_base
{
    friend class debug_layout_graph;

    friend struct implementation::builder_scroll_label;
    friend struct implementation::builder_scrollbar_panel;
    friend class listbox;
    friend class tree_view;
    friend struct scrollbar_container_implementation;

public:
    explicit scrollbar_container(const implementation::builder_styled_widget& builder, const std::string& control_type);

    virtual ~scrollbar_container()
    {
    }

    /** The way to handle the showing or hiding of the scrollbar. */
    enum scrollbar_mode {
        /**
         * The scrollbar is always shown, whether needed or not.
         */
        ALWAYS_VISIBLE,

        /**
         * The scrollbar is never shown even notwhen needed. There's also no space
         * reserved for the scrollbar.
         */
        ALWAYS_INVISIBLE,

        /**
         * The scrollbar is shown when the number of items is larger as the visible items.
         * The space for the scrollbar is always reserved, just in case it's needed after
         * the initial sizing (due to adding items).
         */
        AUTO_VISIBLE,

        /**
         * Like AUTO_VISIBLE, but when not needed upon the initial layout phase, the bars
         * are not shown and no space is reserved for them. (The algorithm hides them by
         * default.
         */
        AUTO_VISIBLE_FIRST_RUN,
    };

    /***** ***** ***** ***** layout functions ***** ***** ***** *****/

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

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

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

    /**
     * See @ref widget::can_wrap.
     *
     * @note This function is called before the object is finalized.
     */
    virtual bool can_wrap() const override;

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

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

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

    /** See @ref widget::set_visible_rectangle. */
    virtual void set_visible_rectangle(const SDL_Rect& rectangle) override;

    /***** ***** ***** inherited ****** *****/

    /** See @ref styled_widget::get_active. */
    virtual bool get_active() const override;

    /** See @ref styled_widget::get_state. */
    virtual unsigned get_state() const 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;

    /** See @ref widget::find. */
    widget* find(const std::string& id, const bool must_be_active) override;

    /** See @ref widget::find. */
    const widget* find(const std::string& id, const bool must_be_active) const override;

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

    /***** ***** ***** setters / getters for members ***** ****** *****/

    /** @note shouldn't be called after being shown in a dialog. */
    void set_vertical_scrollbar_mode(const scrollbar_mode scrollbar_mode);

    scrollbar_mode get_vertical_scrollbar_mode() const
    {
        return vertical_scrollbar_mode_;
    }

    /** @note shouldn't be called after being shown in a dialog. */
    void set_horizontal_scrollbar_mode(const scrollbar_mode scrollbar_mode);

    scrollbar_mode get_horizontal_scrollbar_mode() const
    {
        return horizontal_scrollbar_mode_;
    }

    grid* content_grid()
    {
        return content_grid_.get();
    }

    const grid* content_grid() const
    {
        return content_grid_.get();
    }

    const SDL_Rect& content_visible_area() const
    {
        return content_visible_area_;
    }

    /***** ***** ***** scrollbar helpers ***** ****** *****/

    /* Returns at_end status of the vertical scrollbar.
     *
     */
    bool vertical_scrollbar_at_end();

    /**
     * Returns current position of the vertical scrollbar.
     *
     */
    unsigned get_vertical_scrollbar_item_position() const;

    /**
     * Move the vertical scrollbar to a position.
     *
     * @param position              The position to scroll to.
     */
    void set_vertical_scrollbar_item_position(const unsigned position);

    /**
     * Returns current position of the horizontal scrollbar.
     *
     */
    unsigned get_horizontal_scrollbar_item_position() const;

    /**
     * Move the horizontal scrollbar to a position.
     *
     * @param position              The position to scroll to.
     */
    void set_horizontal_scrollbar_item_position(const unsigned position);

    /**
     * Scrolls the vertical scrollbar.
     *
     * @param scroll              The position to scroll to.
     */
    void scroll_vertical_scrollbar(const scrollbar_base::scroll_mode scroll);

    /**
     * Scrolls the horizontal scrollbar.
     *
     * @param scroll              The position to scroll to.
     */
    void scroll_horizontal_scrollbar(const scrollbar_base::scroll_mode scroll);

    /**
     * Callback when the scrollbar moves (NOTE maybe only one callback needed).
     * Maybe also make protected or private and add a friend.
     */
    void vertical_scrollbar_moved()
    {
        scrollbar_moved();
    }

    void horizontal_scrollbar_moved()
    {
        scrollbar_moved();
    }

protected:
    /**
     * Shows a certain part of the content.
     *
     * When the part to be shown is bigger as the visible viewport the top
     * left of the wanted rect will be the top left of the viewport.
     *
     * @param rect                The rect which should be visible.
     */
    void show_content_rect(const SDL_Rect& rect);

    /*
     * The widget contains the following three grids.
     *
     * * _vertical_scrollbar_grid containing at least a widget named
     *   _vertical_scrollbar
     *
     * * _horizontal_scrollbar_grid containing at least a widget named
     *   _horizontal_scrollbar
     *
     * * _content_grid a grid which holds the contents of the area.
     *
     * NOTE maybe just hardcode these in the finalize phase...
     *
     */

    /**
     * Sets the status of the scrollbar buttons.
     *
     * This is needed after the scrollbar moves so the status of the buttons
     * will be active or inactive as needed.
     */
    void set_scrollbar_button_status();

    /**
     * Notification if the content of a child needs a resize.
     *
     * When a resize is required the container first can try to handle it
     * itself. If it can't honor the request the function will call @ref
     * window::invalidate_layout().
     *
     * @note Calling this function on a widget with size == (0, 0) results
     * false but doesn't call invalidate_layout, the engine expects to be in
     * build up phase with the layout already invalidated.
     *
     * @param force_sizing        If the contents fit do we want to force a
     *                            resize? This is needed in the MP lobby since
     *                            items might not be properly placed yet.
     *                            (The listboxes with the player info need it.)
     *
     * @returns                   True if the resize is handled, false
     *                            otherwise.
     */
    bool content_resize_request(const bool force_sizing = false);

    /**
     * Request from the content to modify the size of the container.
     *
     * When the wanted resize fails the function will call @ref
     * window::invalidate_layout().
     *
     *
     * @note Calling this function on a widget with size == (0, 0) results
     * false but doesn't call invalidate_layout, the engine expects to be in
     * build up phase with the layout already invalidated.
     *
     * @note If @ref window::get_need_layout() is true the function returns
     * false and doesn't try to fit the contents since a layout phase will be
     * triggered anyway.
     *
     * @note This function might replace the @ref content_resize_request above.
     *
     * @param width_modification  The wanted modification to the width:
     *                            * negative values reduce width.
     *                            * zero leave width as is.
     *                            * positive values increase width.
     * @param height_modification The wanted modification to the height:
     *                            * negative values reduce height.
     *                            * zero leave height as is.
     *                            * positive values increase height.
     * @param width_modification_pos
     *                            The position where the additional content was
     *                            inserted/removed, defaults to -1 which means
     *                            'at end'
     * @param height_modification_pos
     *                            The position where the additional content was
     *                            inserted/removed, defaults to -1 which means
     *                            'at end'
     *
     * @returns                   True is wanted modification is accepted false
     *                            otherwise.
     */
    bool content_resize_request(const int width_modification,
            const int height_modification,
            const int width_modification_pos = -1,
            const int height_modification_pos = -1);

private:
    /**
     * Helper for @ref content_resize_request.
     *
     * Handle the width modification.
     */
    bool content_resize_width(const int width_modification, const int width_modification_pos);

    /**
     * Helper for @ref content_resize_request.
     *
     * Handle the height modification.
     */
    bool content_resize_height(const int height_modification, const int width_modification_pos);

protected:
    /***** ***** ***** ***** keyboard functions ***** ***** ***** *****/

    /**
     * Home key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_home(SDL_Keymod modifier, bool& handled);

    /**
     * End key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_end(SDL_Keymod modifier, bool& handled);

    /**
     * Page up key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_page_up(SDL_Keymod modifier, bool& handled);

    /**
     * Page down key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_page_down(SDL_Keymod modifier, bool& handled);

    /**
     * Up arrow key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_up_arrow(SDL_Keymod modifier, bool& handled);

    /**
     * Down arrow key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_down_arrow(SDL_Keymod modifier, bool& handled);

    /**
     * Left arrow key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_left_arrow(SDL_Keymod modifier, bool& handled);

    /**
     * Right arrow key pressed.
     *
     * @param modifier            The SDL keyboard modifier when the key was
     *                            pressed.
     * @param handled             If the function handles the key it should
     *                            set handled to true else do not modify it.
     *                            This is used in the keyboard event
     *                            changing.
     */
    virtual void handle_key_right_arrow(SDL_Keymod modifier, bool& handled);

private:
    /**
     * Possible states of the widget.
     *
     * Note the order of the states must be the same as defined in settings.hpp.
     */
    enum state_t {
        ENABLED,
        DISABLED,
    };

    /**
     * Current state of the widget.
     *
     * The state of the widget determines what to render and how the widget
     * reacts to certain 'events'.
     */
    state_t state_;

    /**
     * The mode of how to show the scrollbar.
     *
     * This value should only be modified before showing, doing it while
     * showing results in UB.
     */
    scrollbar_mode vertical_scrollbar_mode_, horizontal_scrollbar_mode_;

    /** These are valid after finalize_setup(). */
    grid *vertical_scrollbar_grid_, *horizontal_scrollbar_grid_;

    /** These are valid after finalize_setup(). */
    scrollbar_base *vertical_scrollbar_, *horizontal_scrollbar_;

    /** The grid that holds the content. */
    std::unique_ptr<grid> content_grid_;

    /** Dummy spacer to hold the contents location. */
    spacer* content_;

    /**
     * Cache for the visible area for the content.
     *
     * The visible area for the content needs to be updated when scrolling.
     */
    SDL_Rect content_visible_area_;

    /** The builder needs to call us so we do our setup. */
    void finalize_setup(); // FIXME make protected

    /**
     * Function for the subclasses to do their setup.
     *
     * This function is called at the end of finalize_setup().
     */
    virtual void finalize_subclass()
    {
    }

    /** See @ref widget::layout_children. */
    virtual void layout_children() 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;

    /**
     * Sets the size of the content grid.
     *
     * This function normally just updates the content grid but can be
     * overridden by a subclass.
     *
     * @param origin              The origin for the content.
     * @param size                The size of the content.
     */
    virtual void set_content_size(const point& origin, const point& size);

    /** Helper function which needs to be called after the scollbar moved. */
    void scrollbar_moved();

public:
    /** Static type getter that does not rely on the widget being constructed. */
    static const std::string& type();

private:
    /** See @ref styled_widget::get_control_type. */
    virtual const std::string& get_control_type() const override;

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

    void signal_handler_sdl_key_down(
            const event::ui_event event, bool& handled, const SDL_Keycode key, SDL_Keymod modifier);

    void signal_handler_sdl_wheel_up(const event::ui_event event, bool& handled);
    void signal_handler_sdl_wheel_down(const event::ui_event event, bool& handled);
    void signal_handler_sdl_wheel_left(const event::ui_event event, bool& handled);
    void signal_handler_sdl_wheel_right(const event::ui_event event, bool& handled);
    void signal_handler_sdl_touch_motion(const event::ui_event event, bool& handled,
                                         const point& position, const point& distance);

public:
    scrollbar_base* horizontal_scrollbar()
    {
        return horizontal_scrollbar_;
    }

    scrollbar_base* vertical_scrollbar()
    {
        return vertical_scrollbar_;
    }

    grid* get_horizontal_scrollbar_grid()
    {
        return horizontal_scrollbar_grid_;
    }

    grid* get_vertical_scrollbar_grid()
    {
        return vertical_scrollbar_grid_;
    }
};

} // namespace gui2