Panel.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2022 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_PANEL_HPP
#define TGUI_PANEL_HPP
 
 
#include <TGUI/Widgets/Group.hpp>
#include <TGUI/Renderers/PanelRenderer.hpp>
 
 
namespace tgui
{
    class TGUI_API Panel : public Group
    {
    public:
 
        typedef std::shared_ptr<Panel> Ptr; 
        typedef std::shared_ptr<const Panel> ConstPtr; 
 
 
        Panel(const char* typeName = "Panel", bool initRenderer = true);
 
 
        static Panel::Ptr create(Layout2d size = {"100%", "100%"});
 
 
        static Panel::Ptr copy(Panel::ConstPtr panel);
 
 
        PanelRenderer* getSharedRenderer();
        const PanelRenderer* getSharedRenderer() const;
 
        PanelRenderer* getRenderer();
        const PanelRenderer* getRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        Vector2f getInnerSize() const override;
 
 
        Vector2f getChildWidgetsOffset() const override;
 
 
        bool isMouseOnWidget(Vector2f pos) const override;
 
        void leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void rightMousePressed(Vector2f pos) override;
 
        void rightMouseReleased(Vector2f pos) override;
 
        void rightMouseButtonNoLongerDown() override;
 
 
        void draw(BackendRenderTargetBase& target, RenderStates states) const override;
 
 
    protected:
 
        Signal& getSignal(String signalName) override;
 
 
        void rendererChanged(const String& property) override;
 
 
        // This function is called every frame with the time passed since the last frame.
        bool updateTime(Duration elapsedTime) override;
 
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<Panel>(*this);
        }
 
 
    public:
 
        SignalVector2f onMousePress   = {"MousePressed"};   
        SignalVector2f onMouseRelease = {"MouseReleased"};  
        SignalVector2f onClick        = {"Clicked"};        
        SignalVector2f onDoubleClick  = {"DoubleClicked"};  
 
        SignalVector2f onRightMousePress   = {"RightMousePressed"};   
        SignalVector2f onRightMouseRelease = {"RightMouseReleased"};  
        SignalVector2f onRightClick        = {"RightClicked"};        
 
 
    protected:
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color   m_borderColorCached;
        Color   m_backgroundColorCached;
        Sprite  m_spriteBackground;
 
        float   m_roundedBorderRadius = 0;
 
        bool    m_rightMouseDown = false;
 
        // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
        bool m_possibleDoubleClick = false;
 
    };
 
}
 
 
#endif // TGUI_PANEL_HPP