SeparatorLine.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_SEPARATOR_LINE_HPP
#define TGUI_SEPARATOR_LINE_HPP
 
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Renderers/SeparatorLineRenderer.hpp>

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

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

        TGUI_NODISCARD static SeparatorLine::Ptr create(const Layout2d& size = {"100%", 1});

        TGUI_NODISCARD static SeparatorLine::Ptr copy(const SeparatorLine::ConstPtr& separator);

        TGUI_NODISCARD SeparatorLineRenderer* getSharedRenderer() override;
        TGUI_NODISCARD const SeparatorLineRenderer* getSharedRenderer() const override;

        TGUI_NODISCARD SeparatorLineRenderer* getRenderer() override;

        void draw(BackendRenderTarget& target, RenderStates states) const override;

    protected:

        void rendererChanged(const String& property) override;

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

    protected:
 
        // Cached renderer properties
        Color m_colorCached = Color::Black;

    };

}

 
#endif // TGUI_SEPARATOR_LINE_HPP