Scrollable.h

Go to the documentation of this file.

// Copyright (c) 2025 Dave R. Smith.
// Malena Framework — Licensed under PolyForm Noncommercial 1.0.0; commercial use requires a paid license. See LICENSE.
 
//
// Scrollable.h
//
 
#pragma once
#include <Malena/Core/malena_export.h>
#include <Malena/Engine/Events/Fireable.h>
#include <Malena/Engine/Events/EventDispatcher.h>
#include <Malena/Engine/Events/EventReceiver.h>
 
namespace ml
{
    class MALENA_API Scrollable : public EventReceiver
    {
    public:
        // ── Mouse wheel ───────────────────────────────────────────────────────

        void onScroll(std::function<void()> callback, bool overwrite = true);

        void onScroll(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
 
        // ── Mouse moved (fires for all components regardless of hover) ─────────

        void onMouseMoved(std::function<void()> callback, bool overwrite = true);

        void onMouseMoved(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
 
        // ── Mouse button pressed (raw — before click logic) ───────────────────

        void onMousePressed(std::function<void()> callback, bool overwrite = true);

        void onMousePressed(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
 
        // ── Mouse button released (raw — before click logic) ──────────────────

        void onMouseReleased(std::function<void()> callback, bool overwrite = true);

        void onMouseReleased(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
    };


    class MALENA_API ScrollableDispatcher : public EventDispatcher
    {
    public:
        bool occurred(const std::optional<sf::Event>& event) override;
        bool filter(const std::optional<sf::Event>& event, Core* component) override;
        void fire(const std::optional<sf::Event>& event) override;
    };
 
} // namespace ml
 
ML_EXPORT(ScrollableDispatcher)