Scrollbar.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_SCROLLBAR_HPP
#define TGUI_SCROLLBAR_HPP
 
 
#include <TGUI/Widget.hpp>
 
 
namespace tgui
{
 class ScrollbarRenderer;
 
 class TGUI_API Scrollbar : public Widget
 {
 public:
 
 typedef std::shared_ptr<Scrollbar> Ptr; 
 typedef std::shared_ptr<const Scrollbar> ConstPtr; 
 
 
 // Default constructor
 Scrollbar();
 
 
 static Scrollbar::Ptr create();
 
 
 static Scrollbar::Ptr copy(Scrollbar::ConstPtr scrollbar);
 
 
 std::shared_ptr<ScrollbarRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ScrollbarRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 void setMaximum(unsigned int maximum);
 
 
 void setValue(unsigned int value);
 
 
 void setLowValue(unsigned int lowValue);
 
 
 unsigned int getMaximum() const
 {
 return m_maximum;
 }
 
 
 unsigned int getValue() const
 {
 return m_value;
 }
 
 
 unsigned int getLowValue() const
 {
 return m_lowValue;
 }
 
 
 void setArrowScrollAmount(unsigned int scrollAmount)
 {
 m_scrollAmount = scrollAmount;
 }
 
 
 unsigned int getArrowScrollAmount()
 {
 return m_scrollAmount;
 }
 
 
 void setAutoHide(bool autoHide)
 {
 m_autoHide = autoHide;
 }
 
 
 bool getAutoHide() const
 {
 return m_autoHide;
 }
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 virtual void widgetFocused() override;
 
 virtual void mouseNoLongerDown() 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<Scrollbar>(*this);
 }
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 enum class Part
 {
 Track,
 Thumb,
 ArrowUp,
 ArrowDown
 };
 
 // Keep track on which part of the scrollbar the mouse is standing
 Part m_mouseHoverOverPart = Part::Thumb;
 
 // When the mouse went down, did it go down on top of the thumb? If so, where?
 bool m_mouseDownOnThumb = false;
 sf::Vector2f m_mouseDownOnThumbPos;
 
 unsigned int m_maximum = 10;
 unsigned int m_value = 0;
 
 // Maximum should be above this value before the scrollbar is needed
 unsigned int m_lowValue = 6;
 
 // Is the scrollbar draw vertically?
 bool m_verticalScroll = true;
 
 // Does the image lie vertically?
 bool m_verticalImage = true;
 
 // How far should the value change when pressing one of the arrows?
 unsigned int m_scrollAmount = 1;
 
 // When no scrollbar is needed, should the scrollbar be drawn or stay hidden?
 bool m_autoHide = true;
 
 // Did the mouse went down on one of the arrows?
 bool m_mouseDownOnArrow = false;
 
 sf::FloatRect m_track;
 sf::FloatRect m_thumb;
 sf::FloatRect m_arrowUp;
 sf::FloatRect m_arrowDown;
 
 // ListBox, ComboBox and TextBox can access the scrollbar directly
 friend class ListBox;
 friend class ComboBox;
 friend class TextBox;
 friend class ChatBox;
 
 friend class ScrollbarRenderer;
 
 
 };
 
 
 
 class TGUI_API ScrollbarRenderer : public WidgetRenderer
 {
 public:
 
 ScrollbarRenderer(Scrollbar* scrollbar) : m_scrollbar{scrollbar} {}
 
 
 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 setTrackColor(const Color& color);
 
 
 void setTrackColorNormal(const Color& color);
 
 
 void setTrackColorHover(const Color& color);
 
 
 void setThumbColor(const Color& color);
 
 
 void setThumbColorNormal(const Color& color);
 
 
 void setThumbColorHover(const Color& color);
 
 
 void setArrowBackgroundColor(const Color& color);
 
 
 void setArrowBackgroundColorNormal(const Color& color);
 
 
 void setArrowBackgroundColorHover(const Color& color);
 
 
 void setArrowColor(const Color& color);
 
 
 void setArrowColorNormal(const Color& color);
 
 
 void setArrowColorHover(const Color& color);
 
 
 void setTrackTexture(const Texture& texture);
 
 
 void setTrackHoverTexture(const Texture& texture);
 
 
 void setThumbTexture(const Texture& texture);
 
 
 void setThumbHoverTexture(const Texture& texture);
 
 
 void setArrowUpTexture(const Texture& texture);
 
 
 void setArrowDownTexture(const Texture& texture);
 
 
 void setArrowUpHoverTexture(const Texture& texture);
 
 
 void setArrowDownHoverTexture(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:
 
 Scrollbar* m_scrollbar;
 
 Texture m_textureTrackNormal;
 Texture m_textureTrackHover;
 Texture m_textureThumbNormal;
 Texture m_textureThumbHover;
 Texture m_textureArrowUpNormal;
 Texture m_textureArrowUpHover;
 Texture m_textureArrowDownNormal;
 Texture m_textureArrowDownHover;
 
 sf::Color m_trackColorNormal = {255, 255, 255};
 sf::Color m_trackColorHover = {255, 255, 255};
 sf::Color m_thumbColorNormal = {220, 220, 220};
 sf::Color m_thumbColorHover = {210, 210, 210};
 sf::Color m_arrowBackgroundColorNormal = {245, 245, 245};
 sf::Color m_arrowBackgroundColorHover = {255, 255, 255};
 sf::Color m_arrowColorNormal = { 60, 60, 60};
 sf::Color m_arrowColorHover = { 0, 0, 0};
 
 friend class Scrollbar;
 
 };
 
}
 
 
#endif // TGUI_SCROLLBAR_HPP