scrollarea.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_SCROLLAREA_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_SCROLLAREA_HPP_
 
// Standard library includes
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/listeners/mouselistener.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class FIFEGUI_API ScrollArea : public MouseListener, public Widget
    {
        public:
            enum class ScrollPolicy : uint8_t
            {
                ShowAlways = 0,
                ShowNever,
                ShowAuto
            };
 
            ScrollArea();

            explicit ScrollArea(Widget* content);

            ScrollArea(Widget* content, ScrollPolicy hPolicy, ScrollPolicy vPolicy);
 
            ~ScrollArea() override;
 
            ScrollArea(ScrollArea const &)            = delete;
            ScrollArea& operator=(ScrollArea const &) = delete;
            ScrollArea(ScrollArea&&)                  = delete;
            ScrollArea& operator=(ScrollArea&&)       = delete;

            void setContent(Widget* widget);

            Widget* getContent() const;

            void setHorizontalScrollPolicy(ScrollPolicy hPolicy);

            ScrollPolicy getHorizontalScrollPolicy() const;

            void setVerticalScrollPolicy(ScrollPolicy vPolicy);

            ScrollPolicy getVerticalScrollPolicy() const;

            void setScrollPolicy(ScrollPolicy hPolicy, ScrollPolicy vPolicy);

            void setVerticalScrollAmount(int vScroll);

            int getVerticalScrollAmount() const;

            void setHorizontalScrollAmount(int hScroll);

            int getHorizontalScrollAmount() const;

            void setScrollAmount(int hScroll, int vScroll);

            int getHorizontalMaxScroll();

            int getVerticalMaxScroll();

            void setScrollbarWidth(int width);

            int getScrollbarWidth() const;

            void setLeftButtonScrollAmount(int amount);

            void setRightButtonScrollAmount(int amount);

            void setUpButtonScrollAmount(int amount);

            void setDownButtonScrollAmount(int amount);

            int getLeftButtonScrollAmount() const;

            int getRightButtonScrollAmount() const;

            int getUpButtonScrollAmount() const;

            int getDownButtonScrollAmount() const;

            void setOpaque(bool opaque);

            bool isOpaque() const;
 
            // Inherited from Container
 
            void showWidgetPart(Widget* widget, Rectangle area) override;
 
            Rectangle getChildrenArea() override;

            virtual Widget* getWidgetAt(int x, int y);
 
            // Inherited from Widget
 
            void draw(Graphics* graphics) override;
 
            void logic() override;

            void setWidth(int width) override;

            void setHeight(int height) override;

            void setDimension(Rectangle const & dimension) override;
 
            using Widget::expandContent;
            using Widget::resizeToContent;
 
            void resizeToContent(bool recursion = true) override;
 
            void adjustSize() override;
 
            void expandContent(bool recursion) override;
 
            // Inherited from MouseListener
 
            void mousePressed(MouseEvent& mouseEvent) override;
 
            void mouseReleased(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;
 
        protected:
            virtual void drawBackground(Graphics* graphics);

            virtual void drawUpButton(Graphics* graphics);

            virtual void drawDownButton(Graphics* graphics);

            virtual void drawLeftButton(Graphics* graphics);

            virtual void drawRightButton(Graphics* graphics);

            virtual void drawVBar(Graphics* graphics);

            virtual void drawHBar(Graphics* graphics);

            virtual void drawVMarker(Graphics* graphics);

            virtual void drawHMarker(Graphics* graphics);

            virtual void checkPolicies(); // cppcheck-suppress virtualCallInConstructor

            Rectangle getUpButtonDimension();

            Rectangle getDownButtonDimension();

            Rectangle getLeftButtonDimension();

            Rectangle getRightButtonDimension();

            Rectangle getVerticalBarDimension();

            Rectangle getHorizontalBarDimension();

            Rectangle getVerticalMarkerDimension();

            Rectangle getHorizontalMarkerDimension();

            int mVScroll{0};

            int mHScroll{0};

            int mScrollbarWidth{12};

            ScrollPolicy mHPolicy{ScrollPolicy::ShowAuto};

            ScrollPolicy mVPolicy{ScrollPolicy::ShowAuto};

            bool mVBarVisible{false};

            bool mHBarVisible{false};

            bool mUpButtonPressed{false};

            bool mDownButtonPressed{false};

            bool mLeftButtonPressed{false};

            bool mRightButtonPressed{false};

            int mUpButtonScrollAmount{10};

            int mDownButtonScrollAmount{10};

            int mLeftButtonScrollAmount{10};

            int mRightButtonScrollAmount{10};

            bool mIsVerticalMarkerDragged{false};

            bool mIsHorizontalMarkerDragged{false};

            int mHorizontalMarkerDragOffset{0};

            int mVerticalMarkerDragOffset{0};

            bool mOpaque{true};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_SCROLLAREA_HPP_