inputevent.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_INPUTEVENT_HPP_
#define INCLUDE_FIFECHAN_INPUTEVENT_HPP_
 
// Standard library includes
#include <cstdint>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/events/event.hpp"
 
namespace fcn
{
    class FIFEGUI_API InputEvent : public Event
    {
        public:
            static constexpr uint16_t ModShift   = 1 << 0; 
            static constexpr uint16_t ModControl = 1 << 1; 
            static constexpr uint16_t ModAlt     = 1 << 2; 
            static constexpr uint16_t ModMeta    = 1 << 3; 

            InputEvent(
                Widget* source,
                Widget* distributor,
                bool isShiftPressed,
                bool isControlPressed,
                bool isAltPressed,
                bool isMetaPressed);

            bool isShiftPressed() const;

            bool isControlPressed() const;

            bool isAltPressed() const;

            bool isMetaPressed() const;

            uint16_t getModMask() const;

            void consume();

            bool isConsumed() const;

            Widget* getDistributor() const;
 
        protected:
            uint16_t mModMask{0};

            bool mIsConsumed;

            Widget* mDistributor;

            friend class Gui;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_INPUTEVENT_HPP_