key.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_KEY_HPP_
#define INCLUDE_FIFECHAN_KEY_HPP_
 
#include <cstdint>
 
#include "fifechan/platform.hpp"
 
namespace fcn
{
    class FIFEGUI_API Key
    {
    public:
        explicit Key(int value = 0);

        bool isCharacter() const;

        bool isNumber() const;

        bool isLetter() const;

        int getValue() const;

        bool operator==(Key const & key) const;

        bool operator!=(Key const & key) const;

        enum : std::int16_t
        {
            Space   = ' ',
            Tab     = '\t',
            Enter   = '\n',
            LeftAlt = -1000,
            RightAlt,
            LeftShift,
            RightShift,
            LeftControl,
            RightControl,
            LeftMeta,
            RightMeta,
            LeftSuper,
            RightSuper,
            Insert,
            Home,
            PageUp,
            Delete,
            End,
            PageDown,
            Escape,
            CapsLock,
            Backspace,
            F1,
            F2,
            F3,
            F4,
            F5,
            F6,
            F7,
            F8,
            F9,
            F10,
            F11,
            F12,
            F13,
            F14,
            F15,
            PrintScreen,
            ScrollLock,
            Pause,
            NumLock,
            AltGr,
            Left,
            Right,
            Up,
            Down,
            At
        };
 
    protected:
        int mValue;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_KEY_HPP_