Grid.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_GRID_HPP
#define TGUI_GRID_HPP
 
#include <TGUI/Container.hpp>
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
    #include <unordered_map>
#endif

 
TGUI_MODULE_EXPORT namespace tgui
{
 
    class TGUI_API Grid : public Container
    {
    public:
 
        using Ptr = std::shared_ptr<Grid>; 
        using ConstPtr = std::shared_ptr<const Grid>; 
 
        static constexpr const char StaticWidgetType[] = "Grid"; 

        enum class Alignment
        {
            Center,      
            UpperLeft,   
            Up,          
            UpperRight,  
            Right,       
            BottomRight, 
            Bottom,      
            BottomLeft,  
            Left         
        };

        Grid(const char* typeName = StaticWidgetType, bool initRenderer = true);

        TGUI_NODISCARD static Grid::Ptr create();

        Grid(const Grid& copy);

        Grid(Grid&& copy) noexcept;

        Grid& operator= (const Grid& right);

        Grid& operator= (Grid&& right) noexcept;

        TGUI_NODISCARD static Grid::Ptr copy(const Grid::ConstPtr& grid);

        void setSize(const Layout2d& size) override;
        using Widget::setSize;

        void setAutoSize(bool autoSize);

        TGUI_NODISCARD bool getAutoSize() const;

        bool remove(const Widget::Ptr& widget) override;

        void removeAllWidgets() override;

        void addWidget(const Widget::Ptr& widget,
                       std::size_t        row,
                       std::size_t        column,
                       Alignment          alignment = Alignment::Center,
                       const Padding&     padding   = Padding{0});

        bool setWidgetCell(const Widget::Ptr& widget,
                           std::size_t        row,
                           std::size_t        column,
                           Alignment          alignment = Alignment::Center,
                           const Padding&     padding   = Padding{0});

        TGUI_NODISCARD Widget::Ptr getWidget(std::size_t row, std::size_t column) const;

        TGUI_NODISCARD const std::unordered_map<Widget::Ptr, std::pair<std::size_t, std::size_t>>& getWidgetLocations() const;

        void setWidgetPadding(const Widget::Ptr& widget, const Padding& padding = {});

        void setWidgetPadding(std::size_t row, std::size_t column, const Padding& padding = {});

        TGUI_NODISCARD Padding getWidgetPadding(const Widget::Ptr& widget) const;

        TGUI_NODISCARD Padding getWidgetPadding(std::size_t row, std::size_t column) const;

        void setWidgetAlignment(const Widget::Ptr& widget, Alignment alignment = Alignment::Center);

        void setWidgetAlignment(std::size_t row, std::size_t column, Alignment alignment = Alignment::Center);

        TGUI_NODISCARD Alignment getWidgetAlignment(const Widget::Ptr& widget) const;

        TGUI_NODISCARD Alignment getWidgetAlignment(std::size_t row, std::size_t column) const;

        TGUI_NODISCARD const std::vector<std::vector<Widget::Ptr>>& getGridWidgets() const;

        TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;

    protected:

        TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;

        void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;

        // Returns the minimum size required by the grid to display correctly all widgets.
        TGUI_NODISCARD Vector2f getMinimumSize() const;

        // Reposition all the widgets.
        void updatePositionsOfAllWidgets();

        // Updates the position and size of the widget
        void updateWidgets();

        // Updates the grid to the correct size when auto-sizing. This function should only be called if m_autoSize is true.
        void recalculateAutoSize();

        // Makes a copy of the widget
        TGUI_NODISCARD Widget::Ptr clone() const override;

    protected:
 
        bool m_autoSize = true;
 
        std::vector<std::vector<Widget::Ptr>> m_gridWidgets;
        std::vector<std::vector<Padding>>     m_objPadding;
        std::vector<std::vector<Alignment>>   m_objAlignment;
 
        std::vector<float> m_rowHeight;
        std::vector<float> m_columnWidth;
 
        std::unordered_map<Widget::Ptr, std::pair<std::size_t, std::size_t>> m_widgetCells;
 
        std::unordered_map<Widget::Ptr, unsigned int> m_connectedSizeCallbacks;

    };

}

 
#endif // TGUI_GRID_HPP