Button.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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/Widgets/Label.hpp>
 
 
namespace tgui
{
 class Container;
 class ButtonRenderer;
 
 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(sf::String text = "");
 
 
 static Button::Ptr copy(Button::ConstPtr button);
 
 
 std::shared_ptr<ButtonRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ButtonRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 virtual void setFont(const Font& font) override;
 
 
 void setText(const sf::String& text);
 
 
 const sf::String& getText() const
 {
 return m_string;
 }
 
 
 void setTextSize(unsigned int size);
 
 
 unsigned int getTextSize() const
 {
 return m_text.getTextSize();
 }
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void keyPressed(const sf::Event::KeyEvent& event) override;
 
 virtual void widgetFocused() override;
 
 
 protected:
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<Button>(*this);
 }
 
 
 // This function is called when the mouse enters the widget. If requested, a callback will be send.
 virtual void mouseEnteredWidget() override;
 
 
 // This function is called when the mouse leaves the widget. If requested, a callback will be send.
 virtual void mouseLeftWidget() override;
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 sf::String m_string;
 Label m_text;
 
 // This will store the size of the text (0 to auto-size)
 unsigned int m_textSize = 0;
 
 friend class ButtonRenderer;
 friend class ChildWindow;
 };
 
 
 class TGUI_API ButtonRenderer : public WidgetRenderer, public WidgetBorders
 {
 public:
 
 ButtonRenderer(Button* button) : m_button{button} {}
 
 
 virtual void setProperty(std::string property, const std::string& value) override;
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value) override;
 
 
 virtual ObjectConverter getProperty(std::string property) const override;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const override;
 
 
 void setTextColor(const Color& color);
 
 
 void setTextColorNormal(const Color& color);
 
 
 void setTextColorHover(const Color& color);
 
 
 void setTextColorDown(const Color& color);
 
 
 void setBackgroundColor(const Color& color);
 
 
 void setBackgroundColorNormal(const Color& color);
 
 
 void setBackgroundColorHover(const Color& color);
 
 
 void setBackgroundColorDown(const Color& color);
 
 
 void setBorderColor(const Color& color);
 
 
 void setNormalTexture(const Texture& texture);
 
 
 void setHoverTexture(const Texture& texture);
 
 
 void setDownTexture(const Texture& texture);
 
 
 void setFocusTexture(const Texture& texture);
 
 
 // Draws the widget on the render target.
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) override;
 
 
 protected:
 
 Button* m_button;
 
 sf::Color m_textColorNormal;
 sf::Color m_textColorHover;
 sf::Color m_textColorDown;
 
 sf::Color m_backgroundColorNormal;
 sf::Color m_backgroundColorHover;
 sf::Color m_backgroundColorDown;
 
 sf::Color m_borderColor;
 
 Texture m_textureNormal;
 Texture m_textureHover;
 Texture m_textureDown;
 Texture m_textureFocused;
 
 friend class Button;
 friend class ChildWindow;
 friend class ChildWindowRenderer;
 friend class MessageBox;
 
 };
 
}
 
 
#endif // TGUI_BUTTON_HPP