Slider.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_SLIDER_HPP
#define TGUI_SLIDER_HPP
 
#include <TGUI/Widget.hpp>
#include <TGUI/Renderers/SliderRenderer.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API Slider : public Widget
 {
 public:
 
 using Ptr = std::shared_ptr<Slider>; 
 using ConstPtr = std::shared_ptr<const Slider>; 
 
 static constexpr const char StaticWidgetType[] = "Slider"; 
 
 Slider(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 TGUI_NODISCARD static Slider::Ptr create(float minimum = 0, float maximum = 10);
 
 TGUI_NODISCARD static Slider::Ptr copy(const Slider::ConstPtr& slider);
 
 TGUI_NODISCARD SliderRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const SliderRenderer* getSharedRenderer() const override;
 
 TGUI_NODISCARD SliderRenderer* getRenderer() override;
 
 void setSize(const Layout2d& size) override;
 using Widget::setSize;
 
 TGUI_NODISCARD Vector2f getFullSize() const override;
 
 TGUI_NODISCARD Vector2f getWidgetOffset() const override;
 
 void setMinimum(float minimum);
 
 TGUI_NODISCARD float getMinimum() const;
 
 void setMaximum(float maximum);
 
 TGUI_NODISCARD float getMaximum() const;
 
 void setValue(float value);
 
 TGUI_NODISCARD float getValue() const;
 
 void setStep(float step);
 
 TGUI_NODISCARD float getStep() const;
 
#ifndef TGUI_REMOVE_DEPRECATED_CODE
 TGUI_DEPRECATED("Use setOrientation instead") void setVerticalScroll(bool vertical);
 
 TGUI_DEPRECATED("Use getOrientation instead") TGUI_NODISCARD bool getVerticalScroll() const;
#endif
 
 void setOrientation(Orientation orientation);
 
 TGUI_NODISCARD Orientation getOrientation() const;
 
 void setInvertedDirection(bool invertedDirection);
 
 TGUI_NODISCARD bool getInvertedDirection() const;
 
 void setChangeValueOnScroll(bool changeValueOnScroll);
 
 TGUI_NODISCARD bool getChangeValueOnScroll() const;
 
 TGUI_NODISCARD bool isMouseOnWidget(Vector2f pos) const override;
 
 bool leftMousePressed(Vector2f pos) override;
 
 void leftMouseReleased(Vector2f pos) override;
 
 void mouseMoved(Vector2f pos) override;
 
 bool scrolled(float delta, Vector2f pos, bool touch) override;
 
 void leftMouseButtonNoLongerDown() override;
 
 void draw(BackendRenderTarget& target, RenderStates states) const override;
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 void rendererChanged(const String& property) override;
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 // Returns the size without the borders
 TGUI_NODISCARD Vector2f getInnerSize() const;
 
 // Updates the position of the thumb based on the current value of the slider
 void updateThumbPosition();
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 public:
 
 SignalFloat onValueChange = {"ValueChanged"}; 
 
 protected:
 
 FloatRect m_thumb;
 
 // When the mouse went down, did it go down on top of the thumb? If so, where?
 bool m_mouseDownOnThumb = false;
 Vector2f m_mouseDownOnThumbPos;
 
 float m_minimum = 0;
 float m_maximum = 10;
 float m_value = 0;
 float m_step = 1;
 
 bool m_invertedDirection = false; // Are min and max swapped?
 bool m_changeValueOnScroll = true; // Does mouseScroll event change slider value?
 
 Orientation m_orientation = Orientation::Horizontal; // Is the slider drawn horizontally or vertically?
 Orientation m_imageOrientation = Orientation::Horizontal; // Does the loaded image lie horizontally or vertically?
 
 Sprite m_spriteTrack;
 Sprite m_spriteTrackHover;
 Sprite m_spriteThumb;
 Sprite m_spriteThumbHover;
 
 // Cached renderer properties
 Borders m_bordersCached;
 Color m_borderColorCached;
 Color m_borderColorHoverCached;
 Color m_thumbColorCached;
 Color m_thumbColorHoverCached;
 Color m_trackColorCached;
 Color m_trackColorHoverCached;
 bool m_thumbWithinTrackCached = false;
 };
 
}
 
 
#endif // TGUI_SLIDER_HPP