unit_preview_pane.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2016 - 2022
    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/container_base.hpp"

#include <string>
#include "utils/optional_reference.hpp"

class unit;
class unit_type;

namespace gui2
{

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

class button;
class drawing;
class image;
class label;
class tree_view;
class tree_view_node;

namespace implementation
{
    struct builder_unit_preview_pane;
}

class unit_preview_pane : public container_base
{
    friend struct implementation::builder_unit_preview_pane;

public:
    explicit unit_preview_pane(const implementation::builder_unit_preview_pane& builder);

    /** Displays the stats of a specified unit type */
    void set_displayed_type(const unit_type& type);

    /** Displays the stats of a specific unit */
    void set_displayed_unit(const unit& u);

    /** Sets the facing of the unit image */
    void set_image_mods(const std::string& mods);

    /** Callback for the profile button */
    void profile_button_callback();

    /** See @ref styled_widget::set_active. */
    virtual void set_active(const bool active) override;

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

    /** See @ref styled_widget::get_state. */
    virtual unsigned get_state() const override;

protected:
    /**
     * Initializes the internal sub-widget pointers.
     * Should be called when building the window, so the pointers
     * are initialized when set_displayed_type() is called.
     */
    void finalize_setup();

private:
    utils::optional_reference<const unit_type> current_type_;

    drawing* icon_type_;
    image* icon_race_;
    image* icon_alignment_;

    label* label_name_;
    label* label_level_;
    label* label_race_;

    styled_widget* label_details_;
    tree_view* tree_details_;

    button* button_profile_;

    std::string image_mods_;

    template<typename T> // This is only a template to avoid including units/attack.hpp
    void print_attack_details(T attacks, tree_view_node& parent_node);

    enum state_t {
        ENABLED
    };

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

private:
    /** Inherited from styled_widget, implemented by REGISTER_WIDGET. */
    virtual const std::string& get_control_type() const override;

    /** See @ref container_base::set_self_active. */
    virtual void set_self_active(const bool active) override;

};

// }---------- DEFINITION ---------{

struct unit_preview_pane_definition : public styled_widget_definition
{

    explicit unit_preview_pane_definition(const config& cfg);

    struct resolution : public resolution_definition
    {
        explicit resolution(const config& cfg);

        builder_grid_ptr grid;
    };
};

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

namespace implementation
{

struct builder_unit_preview_pane : public builder_styled_widget
{
public:
    explicit builder_unit_preview_pane(const config& cfg);

    using builder_styled_widget::build;

    virtual std::unique_ptr<widget> build() const override;

private:
    const std::string image_mods_;
};

} // namespace implementation

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

} // namespace gui2