Keyable.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.
 
//
// Keyable.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>
#include <optional>
namespace ml
{
    class MALENA_API Keyable : public EventReceiver
    {
    public:
        // ── Key press ─────────────────────────────────────────────────────────

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

        void onKeypress(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
 
        // ── Key release ───────────────────────────────────────────────────────

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

        void onKeyRelease(std::function<void(const std::optional<sf::Event>&)> callback, bool overwrite = true);
 
        // ── Text entered (unicode) ────────────────────────────────────────────

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

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


    class MALENA_API KeyableDispatcher : 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(KeyableDispatcher)