Keyboard Codes

The table below shows the IUP codification of common keys in a keyboard. Each key is represented by an integer value, defined in the "iupkey.h" file header, which should be included in the application to use the key definitions. These keys are used in K_ANY and KEYPRESS_CB callbacks to inform the key that was pressed on the keyboard.

From the definition in the table, change the prefix to K_s*, K_c*, K_m* and K_y* to add the respective modifier (Shift, Control, Alt and Sys). Sys in Windows is the Windows key and in Mac is the Apple key. Check the "iupkey.h" file header for all the definitions.

IUP provides definitions only for common control keys and ASCii characters. Other key combinations are accessed using the macros described below. Also, the global attribute "MODKEYSTATE" can be used to detect the combination of two or more modifiers. Notice that some key combinations are never available because they are restricted by the system. Notice that all of this does not affect the IupText and IupMultiline text input.

The iup_isprint(key) macro informs if a key can be directly used as a printable character. The iup_isXkey(key) macro informs if a given key is an extended code. The iup_isKeyPadXkey(key) macro informs if a given key is a numeric keypad code. The iup_isShiftXkey(key) macro informs if a given key is an extended code using the Shift modifier, the iup_isCtrlXkey(key) macro for the Ctrl modifier, the iup_isAltXkey(key) macro for the Alt modifier, and the iup_isSysXkey(key) macro for the Sys modifier. To obtain a key code for a generic combination you can start with the base key from the table and combine it repeated times using the macros iup_XkeyShift(key), iup_XkeyCtrl(key), iup_XkeyAlt(key) and iup_XkeySys(key).

K_CLEAR is reported in Win32, WinUI and macOS. K_HELP is reported in macOS, iOS, Qt and FLTK.

The numeric keypad has its own codes, so its keys can be distinguished from the main keyboard. When Num Lock is off the navigation codes are reported, when it is on the digit codes are reported. Keypad F1 to F4, Keypad Space and Keypad Tab are reported as K_F1 to K_F4, K_SP and K_TAB. TEXTINPUT_CB is not called for the keypad keys, they are reported only in K_ANY and KEYPRESS_CB. In macOS and iOS the keypad has no navigation keys.