AInput.h

/*
 * AUI Framework - Declarative UI toolkit for modern C++20
 * Copyright (C) 2020-2025 Alex2772 and Contributors
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include "AUI/Common/AString.h"
#include "AUI/Reflect/AEnumerate.h"
 
namespace AInput {
   enum Key {
       /* Based on SFML */
       UNKNOWN = -1, 
       LBUTTON = 0,      
       CBUTTON = 1,      
       RBUTTON = 2,      
       /* check APointerIndex for index values */
 
       ANDROID_BACK_BUTTON = 3, 
 
       A = 'A',                 
       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,                   
       DASH,                    
       SPACE,                   
       RETURN,                  
       BACKSPACE,               
       TAB,                     
       PAGEUP,                  
       PAGEDOWN,                
       END,                     
       HOME,                    
       INSERT,                  
       DEL,                     
       ADD,                     
       SUBTRACT,                
       MULTIPLY,                
       DIVIDE,                  
       LEFT,                    
       RIGHT,                   
       UP,                      
       DOWN,                    
       F1,                      
       F2,                      
       F3,                      
       F4,                      
       F5,                      
       F6,                      
       F7,                      
       F8,                      
       F9,                      
       F10,                     
       F11,                     
       F12,                     
       F13,                     
       F14,                     
       F15,                     
       F16,                     
       F17,                     
       F18,                     
       F19,                     
       PAUSE,                   
       CAPSLOCK,                
       SCROLLLOCK,              
       NUMLOCKCLEAR,            
       PRINTSCREEN,             
 
       /* numpad */
       NUMPAD_0,                
       NUMPAD_1,                
       NUMPAD_2,                
       NUMPAD_3,                
       NUMPAD_4,                
       NUMPAD_5,                
       NUMPAD_6,                
       NUMPAD_7,                
       NUMPAD_8,                
       NUMPAD_9,                
       NUMPAD_ADD,              
       NUMPAD_SUBTRACT,         
       NUMPAD_MULTIPLY,         
       NUMPAD_DIVIDE,           
       NUMPAD_COMMA,            
       NUMPAD_PERIOD,           
       NUMPAD_EQUAL,            
       NUMPAD_RETURN,           
 
       /* media keys */
       VOLUMEUP,                
       VOLUMEDOWN,              
       MUTE,                    
       POWER,                   
 
       /* other */
       LANG1,                   
       LANG2,                   
       INTERNATIONAL1,          
       INTERNATIONAL3,          
 
#if AUI_PLATFORM_APPLE
       CMD = LSYSTEM,           
#endif
 
       /* key count */
       KEYCOUNT,                
 
       /* meta keys */
       CMD_CTRL =               
#if AUI_PLATFORM_APPLE
     CMD,
#else
     LCONTROL,
#endif
   };
   API_AUI_VIEWS Key fromNative(int w);
 
   API_AUI_VIEWS int toNative(Key w);
 
   API_AUI_VIEWS AString getName(Key k);
 
   API_AUI_VIEWS bool isKeyDown(Key k);
 
   API_AUI_VIEWS void overrideStateForTesting(Key k, bool value);
 
 
   namespace native {
       API_AUI_VIEWS bool isKeyDown(Key k);
   }
};
 
AUI_ENUM_VALUES(AInput::Key,
               AInput::Key::UNKNOWN,
               AInput::Key::LBUTTON,
               AInput::Key::CBUTTON,
               AInput::Key::RBUTTON,
               AInput::Key::ANDROID_BACK_BUTTON,
               AInput::Key::A,
               AInput::Key::B,
               AInput::Key::C,
               AInput::Key::D,
               AInput::Key::E,
               AInput::Key::F,
               AInput::Key::G,
               AInput::Key::H,
               AInput::Key::I,
               AInput::Key::J,
               AInput::Key::K,
               AInput::Key::L,
               AInput::Key::M,
               AInput::Key::N,
               AInput::Key::O,
               AInput::Key::P,
               AInput::Key::Q,
               AInput::Key::R,
               AInput::Key::S,
               AInput::Key::T,
               AInput::Key::U,
               AInput::Key::V,
               AInput::Key::W,
               AInput::Key::X,
               AInput::Key::Y,
               AInput::Key::Z,
               AInput::Key::NUM0,
               AInput::Key::NUM1,
               AInput::Key::NUM2,
               AInput::Key::NUM3,
               AInput::Key::NUM4,
               AInput::Key::NUM5,
               AInput::Key::NUM6,
               AInput::Key::NUM7,
               AInput::Key::NUM8,
               AInput::Key::NUM9,
               AInput::Key::ESCAPE,
               AInput::Key::LCONTROL,
               AInput::Key::LSHIFT,
               AInput::Key::LALT,
               AInput::Key::LSYSTEM,
               AInput::Key::RCONTROL,
               AInput::Key::RSHIFT,
               AInput::Key::RALT,
               AInput::Key::RSYSTEM,
               AInput::Key::MENU,
               AInput::Key::LBRACKET,
               AInput::Key::RBRACKET,
               AInput::Key::SEMICOLON,
               AInput::Key::COMMA,
               AInput::Key::PERIOD,
               AInput::Key::QUOTE,
               AInput::Key::SLASH,
               AInput::Key::BACKSLASH,
               AInput::Key::TILDE,
               AInput::Key::EQUAL,
               AInput::Key::DASH,
               AInput::Key::SPACE,
               AInput::Key::RETURN,
               AInput::Key::BACKSPACE,
               AInput::Key::TAB,
               AInput::Key::PAGEUP,
               AInput::Key::PAGEDOWN,
               AInput::Key::END,
               AInput::Key::HOME,
               AInput::Key::INSERT,
               AInput::Key::DEL,
               AInput::Key::ADD,
               AInput::Key::SUBTRACT,
               AInput::Key::MULTIPLY,
               AInput::Key::DIVIDE,
               AInput::Key::LEFT,
               AInput::Key::RIGHT,
               AInput::Key::UP,
               AInput::Key::DOWN,
               AInput::Key::NUMPAD_0,
               AInput::Key::NUMPAD_1,
               AInput::Key::NUMPAD_2,
               AInput::Key::NUMPAD_3,
               AInput::Key::NUMPAD_4,
               AInput::Key::NUMPAD_5,
               AInput::Key::NUMPAD_6,
               AInput::Key::NUMPAD_7,
               AInput::Key::NUMPAD_8,
               AInput::Key::NUMPAD_9,
               AInput::Key::F1,
               AInput::Key::F2,
               AInput::Key::F3,
               AInput::Key::F4,
               AInput::Key::F5,
               AInput::Key::F6,
               AInput::Key::F7,
               AInput::Key::F8,
               AInput::Key::F9,
               AInput::Key::F10,
               AInput::Key::F11,
               AInput::Key::F12,
               AInput::Key::F13,
               AInput::Key::F14,
               AInput::Key::F15,
               AInput::Key::PAUSE,
               AInput::Key::KEYCOUNT)

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.