LoadingBar.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 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_LOADING_BAR_HPP
#define TGUI_LOADING_BAR_HPP


#include <TGUI/ClickableWidget.hpp>


namespace tgui
{

 class TGUI_API LoadingBar : public ClickableWidget
 {
 public:

 typedef SharedWidgetPtr<LoadingBar> Ptr;


 LoadingBar();


 LoadingBar(const LoadingBar& copy);


 virtual ~LoadingBar();


 LoadingBar& operator= (const LoadingBar& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual LoadingBar* clone();


 bool load(const std::string& configFileFilename, const std::string& sectionName = "LoadingBar");


 const std::string& getLoadedConfigFile() const;


 void setSize(float width, float height);


 void setMinimum(unsigned int minimum);


 void setMaximum(unsigned int maximum);


 void setValue(unsigned int value);


 unsigned int getMinimum() const;


 unsigned int getMaximum() const;


 unsigned int getValue() const;


 unsigned int incrementValue();


 void setText(const sf::String& text);


 sf::String getText() const;


 void setTextFont(const sf::Font& font);


 const sf::Font* getTextFont() const;


 void setTextColor(const sf::Color& color);


 const sf::Color& getTextColor() const;


 void setTextSize(unsigned int size);


 unsigned int getTextSize() const;


 virtual void setTransparency(unsigned char transparency);


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 protected:

 // This function is called when the widget is added to a container.
 virtual void initialize(Container *const container);


 // 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;


 public:

 enum LoadingBarCallbacks
 {
 ValueChanged = ClickableWidgetCallbacksCount * 1, 
 LoadingBarFull = ClickableWidgetCallbacksCount * 2, 
 AllLoadingBarCallbacks = ClickableWidgetCallbacksCount * 4 - 1, 
 LoadingBarCallbacksCount = ClickableWidgetCallbacksCount * 4
 };


 protected:

 std::string m_LoadedConfigFile;

 unsigned int m_Minimum;
 unsigned int m_Maximum;
 unsigned int m_Value;

 // If this is true then the L, M and R images will be used.
 // If it is false then the button is just one big image that will be stored in the M image.
 bool m_SplitImage;

 Texture m_TextureBack_L;
 Texture m_TextureBack_M;
 Texture m_TextureBack_R;
 Texture m_TextureFront_L;
 Texture m_TextureFront_M;
 Texture m_TextureFront_R;

 // The text that is (optionally) drawn on top of the loading bar
 sf::Text m_Text;
 unsigned int m_TextSize;
 };

}


#endif // TGUI_LOADING_BAR_HPP