ProgressBar.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_PROGRESS_BAR_HPP
#define TGUI_PROGRESS_BAR_HPP
 
 
#include <TGUI/Widgets/Label.hpp>
 
 
namespace tgui
{
 class ProgressBarRenderer;
 
 class TGUI_API ProgressBar : public ClickableWidget
 {
 public:
 
 typedef std::shared_ptr<ProgressBar> Ptr; 
 typedef std::shared_ptr<const ProgressBar> ConstPtr; 
 
 
 enum class FillDirection
 {
 LeftToRight, 
 RightToLeft, 
 TopToBottom, 
 BottomToTop 
 };
 
 
 ProgressBar();
 
 
 static ProgressBar::Ptr create();
 
 
 static ProgressBar::Ptr copy(ProgressBar::ConstPtr progressBar);
 
 
 std::shared_ptr<ProgressBarRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ProgressBarRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 virtual void setFont(const Font& font) override;
 
 
 void setMinimum(unsigned int minimum);
 
 
 void setMaximum(unsigned int maximum);
 
 
 void setValue(unsigned int value);
 
 
 unsigned int getMinimum() const
 {
 return m_minimum;
 }
 
 
 unsigned int getMaximum() const
 {
 return m_maximum;
 }
 
 
 unsigned int getValue() const
 {
 return m_value;
 }
 
 
 unsigned int incrementValue();
 
 
 void setText(const sf::String& text);
 
 
 sf::String getText() const
 {
 return m_textBack.getText();
 }
 
 
 void setTextSize(unsigned int size);
 
 
 unsigned int getTextSize() const
 {
 return m_textBack.getTextSize();
 }
 
 
 void setFillDirection(FillDirection direction);
 
 
 FillDirection getFillDirection()
 {
 return m_fillDirection;
 }
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const 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<ProgressBar>(*this);
 }
 
 
 // When the value changes, or when the minimum/maximum limits change then a smaller of bigger piece of the front image
 // must be drawn. This function is called to calculate the size of the piece to draw.
 void recalculateSize();
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 unsigned int m_minimum = 0;
 unsigned int m_maximum = 100;
 unsigned int m_value = 0;
 
 Label m_textBack;
 Label m_textFront;
 unsigned int m_textSize = 0;
 
 sf::FloatRect m_frontRect;
 
 FillDirection m_fillDirection = FillDirection::LeftToRight;
 
 friend class ProgressBarRenderer;
 };
 
 
 
 class TGUI_API ProgressBarRenderer : public WidgetRenderer, public WidgetBorders
 {
 public:
 
 ProgressBarRenderer(ProgressBar* progressBar) : m_progressBar{progressBar} {}
 
 
 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 setTextColorBack(const Color& color);
 
 
 void setTextColorFront(const Color& color);
 
 
 void setBackgroundColor(const Color& color);
 
 
 void setForegroundColor(const Color& color);
 
 
 void setBorderColor(const Color& color);
 
 
 void setBackTexture(const Texture& texture);
 
 
 void setFrontTexture(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:
 
 ProgressBar* m_progressBar;
 
 Texture m_textureBack;
 Texture m_textureFront;
 
 sf::Color m_textColorFront;
 sf::Color m_textColorBack;
 
 sf::Color m_backgroundColor;
 sf::Color m_foregroundColor;
 
 sf::Color m_borderColor;
 
 friend class ProgressBar;
 
 };
 
}
 
 
#endif // TGUI_PROGRESS_BAR_HPP