Event.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2025 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_EVENT_HPP
#define TGUI_EVENT_HPP
 
#include <TGUI/Config.hpp>

 
TGUI_MODULE_EXPORT namespace tgui
{
 
    // Based on sf::Event from SFML
    struct Event
    {
        // Based on sf::KeyBoard::Key from SFML
        enum class KeyboardKey
        {
            Unknown = -1, 
            A = 0,        
            B,            
            C,            
            D,            
            E,            
            F,            
            G,            
            H,            
            I,            
            J,            
            K,            
            L,            
            M,            
            N,            
            O,            
            P,            
            Q,            
            R,            
            S,            
            T,            
            U,            
            V,            
            W,            
            X,            
            Y,            
            Z,            
            Num0,         
            Num1,         
            Num2,         
            Num3,         
            Num4,         
            Num5,         
            Num6,         
            Num7,         
            Num8,         
            Num9,         
            Escape,       
            LControl,     
            LShift,       
            LAlt,         
            LSystem,      
            RControl,     
            RShift,       
            RAlt,         
            RSystem,      
            Menu,         
            LBracket,     
            RBracket,     
            Semicolon,    
            Comma,        
            Period,       
            Quote,        
            Slash,        
            Backslash,    
            Tilde,        
            Equal,        
            Minus,        
            Space,        
            Enter,        
            Backspace,    
            Tab,          
            PageUp,       
            PageDown,     
            End,          
            Home,         
            Insert,       
            Delete,       
            Add,          
            Subtract,     
            Multiply,     
            Divide,       
            Left,         
            Right,        
            Up,           
            Down,         
            Numpad0,      
            Numpad1,      
            Numpad2,      
            Numpad3,      
            Numpad4,      
            Numpad5,      
            Numpad6,      
            Numpad7,      
            Numpad8,      
            Numpad9,      
            F1,           
            F2,           
            F3,           
            F4,           
            F5,           
            F6,           
            F7,           
            F8,           
            F9,           
            F10,          
            F11,          
            F12,          
            F13,          
            F14,          
            F15,          
            Pause         
        };

        enum class MouseButton
        {
            Left,   
            Right,  
            Middle  
        };

        enum class KeyModifier
        {
            System,
            Control,
            Shift,
            Alt
        };

        struct KeyEvent
        {
            KeyboardKey code;    
            bool        alt;     
            bool        control; 
            bool        shift;   
            bool        system;  
        };

        struct TextEvent
        {
            char32_t unicode; 
        };

        struct MouseMoveEvent
        {
            int x; 
            int y; 
        };

        struct MouseButtonEvent
        {
            MouseButton button; 
            int         x;      
            int         y;      
        };

        struct MouseWheelEvent
        {
            float delta; 
            int   x;     
            int   y;     
        };

        struct SizeEvent
        {
            unsigned int width;  
            unsigned int height; 
        };

        enum class Type
        {
            LostFocus,              
            GainedFocus,            
            TextEntered,            
            KeyPressed,             
            MouseWheelScrolled,     
            MouseButtonPressed,     
            MouseButtonReleased,    
            MouseMoved,             
            MouseEntered,           
            MouseLeft,              
            Resized,                
            Closed                  
        };

 
        Type type; 
 
        union
        {
            KeyEvent              key;               
            TextEvent             text;              
            MouseMoveEvent        mouseMove;         
            MouseButtonEvent      mouseButton;       
            MouseWheelEvent       mouseWheel;        
            SizeEvent             size;              
        };
    };

}

 
#endif // TGUI_EVENT_HPP