KeyboardKeyActionState.hpp

#ifndef KeyboardKeyActionState_h_
#define KeyboardKeyActionState_h_

#include <cstdint>

/**
 * @file KeyboardKeyActionState.h
 * @brief Defines the KeyboardKeyActionState enum for key press actions.
 *
 * This file contains the definition of the KeyboardKeyActionState enum, which represents
 * various actions or outcomes related to key presses on a keyboard.
 */

namespace Device
{
    /**
     * @enum KeyboardKeyActionState
     * @brief Represents different actions or outcomes related to key presses.
     *
     * The KeyboardKeyActionState enum is used to describe the state of a key press on a keyboard.
     * It provides different states to represent the start of a press, the end of a short or long press,
     * and other relevant states.
     */
    enum class KeyboardKeyActionState : std::uint8_t
    {
        PressStart = 0u,    /**< The user started pressing the key. */
        PressEndShort = 1u, /**< The press has ended and is considered a short-duration press. */
        PressEndLong = 2u,  /**< The press has ended and is considered a long-duration press. */
        PressNot = 3u,      /**< The key is not currently pressed. */
        Fail = 4u           /**< The key is in a fail mode, indicating an error or invalid state. */
    };

}

#endif