Scrollbar.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// 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_INCLUDED_
#define _TGUI_SCROLLBAR_INCLUDED_


namespace tgui
{

 struct TGUI_API Scrollbar : public Slider
 {
 Scrollbar();


 Scrollbar(const Scrollbar& copy);


 virtual ~Scrollbar();


 Scrollbar& operator= (const Scrollbar& right);


 virtual Scrollbar* clone();


 virtual bool load(const std::string& pathname);


 virtual void setMinimum(unsigned int minimum);


 virtual void setValue(unsigned int value);


 virtual void setLowValue(unsigned int lowValue);


 virtual unsigned int getLowValue() const;


 // These functions are used to receive callback from the EventManager.
 // You normally don't need them, but you can use them to simulate an event.
 virtual bool mouseOnObject(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);


 protected:

 // Because this struct is derived from sf::Drawable, you can just call the draw function from your sf::RenderTarget.
 // This function will be called and it will draw the scrollbar on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 bool autoHide;


 protected:

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

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

 sf::Texture* m_TextureArrowNormal;
 sf::Texture* m_TextureArrowHover;

 sf::Sprite m_SpriteArrowNormal;
 sf::Sprite m_SpriteArrowHover;


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


 };

}


#endif //_TGUI_SCROLLBAR_INCLUDED_