slider.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_SLIDER_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_SLIDER_HPP_
 
#include <memory>
 
#include "fifechan/keylistener.hpp"
#include "fifechan/mouselistener.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class FIFEGUI_API Slider : public Widget, public MouseListener, public KeyListener
    {
    public:
        enum class Orientation : uint8_t
        {
            Horizontal = 0,
            Vertical
        };

        explicit Slider(double scaleEnd = 1.0);

        Slider(double scaleStart, double scaleEnd);
 
        ~Slider() override = default;
 
        Slider(Slider const &)            = delete;
        Slider& operator=(Slider const &) = delete;
        Slider(Slider&&)                  = delete;
        Slider& operator=(Slider&&)       = delete;

        void setScale(double scaleStart, double scaleEnd);

        double getScaleStart() const;

        void setScaleStart(double scaleStart);

        double getScaleEnd() const;

        void setScaleEnd(double scaleEnd);

        double getValue() const;

        void setValue(double value);

        void setMarkerLength(int length);

        int getMarkerLength() const;

        void setOrientation(Orientation orientation);

        Orientation getOrientation() const;

        void setStepLength(double length);

        double getStepLength() const;
 
        // Inherited from Widget
 
        void draw(Graphics* graphics) override;
 
        // Inherited from MouseListener.
 
        void mousePressed(MouseEvent& mouseEvent) override;
        void mouseDragged(MouseEvent& mouseEvent) override;
        void mouseWheelMovedUp(MouseEvent& mouseEvent) override;
        void mouseWheelMovedDown(MouseEvent& mouseEvent) override;
        void mouseWheelMovedRight(MouseEvent& mouseEvent) override;
        void mouseWheelMovedLeft(MouseEvent& mouseEvent) override;
 
        // Inherited from KeyListener
 
        void keyPressed(KeyEvent& keyEvent) override;
 
    protected:
        virtual void drawMarker(Graphics* graphics);

        virtual double markerPositionToValue(int position) const;

        virtual int valueToMarkerPosition(double value) const;

        virtual int getMarkerPosition() const;

        bool mDragged{false};

        double mValue{0.0};

        double mStepLength{0.5};

        int mMarkerLength{10};

        double mScaleStart{0.0};

        double mScaleEnd{1.0};

        Orientation mOrientation{Orientation::Horizontal};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_SLIDER_HPP_