Scrollbar.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_SCROLLBAR_HPP
#define TGUI_SCROLLBAR_HPP


#include <TGUI/Slider.hpp>


namespace tgui
{

 class TGUI_API Scrollbar : public Widget
 {
 public:

 typedef SharedWidgetPtr<Scrollbar> Ptr;


 Scrollbar();


 Scrollbar(const Scrollbar& copy);


 virtual ~Scrollbar();


 Scrollbar& operator= (const Scrollbar& 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 Scrollbar* clone();


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


 const std::string& getLoadedConfigFile() const;


 void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 void setMaximum(unsigned int maximum);


 void setValue(unsigned int value);


 void setLowValue(unsigned int lowValue);


 void setVerticalScroll(bool verticallScroll);


 unsigned int getMaximum() const;


 unsigned int getValue() const;


 unsigned int getLowValue() const;


 bool getVerticalScroll() const;


 void setArrowScrollAmount(unsigned int scrollAmount);


 unsigned int getArrowScrollAmount();


 void setAutoHide(bool autoHide);


 bool getAutoHide() const;


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);

 virtual void leftMouseReleased(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void mouseWheelMoved(int delta, int x, int y);

 virtual void widgetFocused();


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


 private:

 // Returns the position and size of the thumb
 sf::FloatRect getThumbRect() const;


 protected:

 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum ScrollbarCallbacks
 {
 ValueChanged = WidgetCallbacksCount * 1, 
 AllScrollbarCallbacks = WidgetCallbacksCount * 2 - 1, 
 ScrollbarCallbacksCount = WidgetCallbacksCount * 2
 };


 protected:

 std::string m_LoadedConfigFile;

 // When the mouse went down, did it go down on top of the thumb? If so, where?
 bool m_MouseDownOnThumb;
 sf::Vector2f m_MouseDownOnThumbPos;
 sf::Vector2f m_lastMousePos;

 unsigned int m_Maximum;
 unsigned int m_Value;

 // Maximum should be above this value before the scrollbar is needed
 unsigned int m_LowValue;

 // Is the scrollbar draw vertically?
 bool m_VerticalScroll;

 // Does the image lie vertically?
 bool m_VerticalImage;

 // How far should the value change when pressing one of the arrows?
 unsigned int m_ScrollAmount;

 // When no scrollbar is needed, should the scrollbar be drawn or stay hidden?
 bool m_AutoHide;

 // Did the mouse went down on one of the arrows?
 bool m_MouseDownOnArrow;

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

 // Is there a separate hover image, or is it a semi-transparent image that is drawn on top of the others?
 bool m_SeparateHoverImage;

 // The size of the scrollbar and its thumb
 sf::Vector2f m_Size;
 sf::Vector2f m_ThumbSize;

 Texture m_TextureTrackNormal_L;
 Texture m_TextureTrackHover_L;
 Texture m_TextureTrackNormal_M;
 Texture m_TextureTrackHover_M;
 Texture m_TextureTrackNormal_R;
 Texture m_TextureTrackHover_R;

 Texture m_TextureThumbNormal;
 Texture m_TextureThumbHover;

 Texture m_TextureArrowUpNormal;
 Texture m_TextureArrowUpHover;

 Texture m_TextureArrowDownNormal;
 Texture m_TextureArrowDownHover;

 // ListBox, ComboBox and TextBox can access the scrollbar directly
 friend class ListBox;
 friend class ComboBox;
 friend class TextBox;
 friend class ChatBox;


 };

}


#endif // TGUI_SCROLLBAR_HPP