Button.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2020 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_BUTTON_HPP
#define TGUI_BUTTON_HPP
 
 
#include <TGUI/Renderers/ButtonRenderer.hpp>
#include <TGUI/Widgets/ClickableWidget.hpp>
#include <TGUI/Text.hpp>
 
 
namespace tgui
{
    class TGUI_API Button : public ClickableWidget
    {
    public:
 
        typedef std::shared_ptr<Button> Ptr; 
        typedef std::shared_ptr<const Button> ConstPtr; 
 
 
        // Default constructor
        Button();
 
 
        static Button::Ptr create(const sf::String& text = "");
 
 
        static Button::Ptr copy(Button::ConstPtr button);
 
 
        ButtonRenderer* getSharedRenderer();
        const ButtonRenderer* getSharedRenderer() const;
 
        ButtonRenderer* getRenderer();
        const ButtonRenderer* getRenderer() const;
 
 
        void setSize(const Layout2d& size) override;
        using Widget::setSize;
 
 
        void setEnabled(bool enabled) override;
 
 
        virtual void setText(const sf::String& text);
 
 
        const sf::String& getText() const;
 
 
        void setTextSize(unsigned int size) override;
 
 
        unsigned int getTextSize() const override;
 
 
        bool mouseOnWidget(Vector2f pos) const override;
 
 
        void leftMousePressed(Vector2f pos) override;
 
        void leftMouseReleased(Vector2f pos) override;
 
        void keyPressed(const sf::Event::KeyEvent& event) override;
 
 
        void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
    protected:
 
        // This function is called when the mouse enters the widget. If requested, a callback will be send.
        void mouseEnteredWidget() override;
 
 
        // This function is called when the mouse leaves the widget. If requested, a callback will be send.
        void mouseLeftWidget() override;
 
 
        Signal& getSignal(std::string signalName) override;
 
 
        void rendererChanged(const std::string& property) override;
 
 
        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 size without the borders
        Vector2f getInnerSize() const;
 
 
        // Returns the background color that is being used in the current state
        const Color& getCurrentBackgroundColor() const;
 
 
        // Returns the border color that is being used in the current state
        const Color& getCurrentBorderColor() const;
 
 
        // Sets the color and style of m_text depending on the current state
        void updateTextColorAndStyle();
 
 
        // Called when size of button is updated
        virtual void updateSize();
 
 
        // Makes a copy of the widget
        Widget::Ptr clone() const override
        {
            return std::make_shared<Button>(*this);
        }
 
 
    public:
 
        SignalString onPress = {"Pressed"}; 
 
 
    protected:
 
        sf::String m_string;
        Text m_text;
 
        bool   m_autoSize = true;
        bool   m_updatingSizeWhileSettingText = false; // Internal variable so that updateSize knows that it is called from setText
 
        Sprite m_sprite;
        Sprite m_spriteHover;
        Sprite m_spriteDown;
        Sprite m_spriteDisabled;
        Sprite m_spriteFocused;
 
        // Cached renderer properties
        Borders m_bordersCached;
        Color   m_borderColorCached;
        Color   m_borderColorHoverCached;
        Color   m_borderColorDownCached;
        Color   m_borderColorDisabledCached;
        Color   m_borderColorFocusedCached;
        Color   m_backgroundColorCached;
        Color   m_backgroundColorHoverCached;
        Color   m_backgroundColorDownCached;
        Color   m_backgroundColorDisabledCached;
        Color   m_backgroundColorFocusedCached;
    };
 
}
 
 
#endif // TGUI_BUTTON_HPP