Label.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_LABEL_HPP
#define TGUI_LABEL_HPP
 
 
#include <TGUI/Widgets/ClickableWidget.hpp>
 
 
namespace tgui
{
 class LabelRenderer;
 
 class TGUI_API Label : public ClickableWidget
 {
 public:
 
 typedef std::shared_ptr<Label> Ptr; 
 typedef std::shared_ptr<const Label> ConstPtr; 
 
 
 enum class HorizontalAlignment
 {
 Left, 
 Center, 
 Right 
 };
 
 
 enum class VerticalAlignment
 {
 Top , 
 Center, 
 Bottom 
 };
 
 
 // Default constructor
 Label();
 
 
 static Label::Ptr create(sf::String text = "");
 
 
 static Label::Ptr copy(Label::ConstPtr label);
 
 
 std::shared_ptr<LabelRenderer> getRenderer() const
 {
 return std::static_pointer_cast<LabelRenderer>(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 setTextStyle(sf::Uint32 style);
 
 
 sf::Uint32 getTextStyle() const;
 
 
 void setTextSize(unsigned int size);
 
 
 unsigned int getTextSize() const;
 
 
 void setHorizontalAlignment(HorizontalAlignment alignment);
 
 
 HorizontalAlignment getHorizontalAlignment() const;
 
 
 void setVerticalAlignment(VerticalAlignment alignment);
 
 
 VerticalAlignment getVerticalAlignment() const;
 
 
 void setTextColor(const Color& color);
 
 
 const sf::Color& getTextColor() const;
 
 
 virtual void setAutoSize(bool autoSize);
 
 
 virtual bool getAutoSize() const
 {
 return m_autoSize;
 }
 
 
 void setMaximumTextWidth(float maximumWidth);
 
 
 float getMaximumTextWidth() const;
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual void setParent(Container* parent) override;
 
 
 virtual void leftMouseReleased(float x, float y) 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<Label>(*this);
 }
 
 
 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;
 
 
 // Rearrange the text, making use of the given size of maximum text width.
 void rearrangeText();
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 sf::RectangleShape m_background;
 
 sf::String m_string;
 std::vector<sf::Text> m_lines;
 
 unsigned int m_textSize = 18;
 sf::Uint32 m_textStyle = sf::Text::Style::Regular;
 HorizontalAlignment m_horizontalAlignment = HorizontalAlignment::Left;
 VerticalAlignment m_verticalAlignment = VerticalAlignment::Top;
 
 bool m_autoSize = true;
 
 float m_maximumTextWidth = 0;
 
 // 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;
 
 friend LabelRenderer;
 
 };
 
 
 
 class TGUI_API LabelRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 LabelRenderer(Label* label) : m_label{label} {}
 
 
 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 setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 void setTextColor(const Color& color);
 
 
 void setBackgroundColor(const Color& color);
 
 
 void setBorderColor(const Color& color);
 
 
 // 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:
 
 Label* m_label;
 
 sf::Color m_textColor;
 sf::Color m_backgroundColor;
 sf::Color m_borderColor;
 
 friend class Label;
 
 };
 
}
 
 
#endif // TGUI_LABEL_HPP