UIResponder.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "UIEvent.hpp"
 
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
namespace CeresEngine {
 
    class UIResponder {
    public:
        virtual ~UIResponder() = default;
 
    public:
        [[nodiscard]] virtual bool acceptsFirstResponder() const { return false; }
 
        [[nodiscard]] virtual bool becomeFirstResponder() { return true; }
 
        [[nodiscard]] virtual bool resignFirstResponder() { return true; }
 
        [[nodiscard]] virtual UIResponder* getNextResponder() const { return nullptr; }
 
    public: // Mouse Events
        virtual void mouseDown(const UIMouseEvent& event);
 
        virtual void mouseDragged(const UIMouseEvent& event);
 
        virtual void mouseUp(const UIMouseEvent& event);
 
        virtual void mouseMoved(const UIMouseEvent& event);
 
        virtual void mouseEntered(const UIMouseEvent& event);
 
        virtual void mouseExited(const UIMouseEvent& event);
 
        virtual void rightMouseDown(const UIMouseEvent& event);
 
        virtual void rightMouseDragged(const UIMouseEvent& event);
 
        virtual void rightMouseUp(const UIMouseEvent& event);
 
        virtual void otherMouseDown(const UIMouseEvent& event);
 
        virtual void otherMouseDragged(const UIMouseEvent& event);
 
        virtual void otherMouseUp(const UIMouseEvent& event);
 
        virtual void scrollWheel(const UIMouseEvent& event);
 
    public: // Key Events
        virtual void keyDown(const UIKeyEvent& event);
 
        virtual void keyUp(const UIKeyEvent& event);
 
        virtual void interpretKeyEvents(const Vector<UIKeyEvent>& events);
 
        virtual bool performKeyEquivalent(const UIKeyEvent& event);
 
        virtual void flushBufferedKeyEvents();
 
    public:
        virtual void cursorUpdate(const UIEvent& event);
 
        virtual void flagsChanged(const UIEvent& event);
 
    public:
        static void dispatch(UIResponder* const firstResponder, const UIEvent& event);
    };
 
} // namespace CeresEngine