BoxLayoutRatios.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_BOX_LAYOUT_RATIOS_HPP
#define TGUI_BOX_LAYOUT_RATIOS_HPP
 
#include <TGUI/Widgets/BoxLayout.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
    class TGUI_API BoxLayoutRatios : public BoxLayout
    {
    public:
 
        using Ptr = std::shared_ptr<BoxLayoutRatios>; 
        using ConstPtr = std::shared_ptr<const BoxLayoutRatios>; 
 
        BoxLayoutRatios(const char* typeName, bool initRenderer);
 
        void add(const Widget::Ptr& widget, const String& widgetName = "") override;
 
        void add(const Widget::Ptr& widget, float ratio, const String& widgetName = "");
 
        void insert(std::size_t index, const Widget::Ptr& widget, const String& widgetName = "") override;
 
        void insert(std::size_t index, const Widget::Ptr& widget, float ratio, const String& widgetName = "");
 
        bool remove(std::size_t index) override;
        using BoxLayout::remove;
 
        void removeAllWidgets() override;
 
        void addSpace(float ratio);
 
        void insertSpace(std::size_t index, float ratio);
 
        bool setRatio(const Widget::Ptr& widget, float ratio);
 
        bool setRatio(std::size_t index, float ratio);
 
        TGUI_NODISCARD float getRatio(const Widget::Ptr& widget) const;
 
        TGUI_NODISCARD float getRatio(std::size_t index) const;
 
    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;
 
    protected:
 
        std::vector<float> m_ratios;
 
    };
 
}
 
 
#endif // TGUI_BOX_LAYOUT_RATIOS_HPP