QB64-PE/internal/help/KEY_LIST.txt

The '''KEY LIST''' statement lists the softkey strings assigned to each of the function keys down the left side of the screen.


{{PageSyntax}}
:: KEY LIST


:: KEY {ON|OFF}


''Description:''
* Instead of using an [[ON KEY(n)]] [[GOSUB]] statement, Function keys F1 to F12 can be assigned a "soft key" string value to return.
* '''[[KEY n]], text$''' defines a literal or variable [[STRING]] "soft key" Function key return value.
{{WhiteStart}}   '''KEY 1, "Help"''' 'will return the string "Help" to an [[INPUT]] variable when F1 is pressed{{WhiteEnd}}
* ''n%'' is the number 1 to 10(F1 to F10), 30 or 31(F11 or F12) of the function key to assign the soft key string.
* [[KEY LIST]] displays each of the 12 softkey '''function key'''(F1 to F12) string values going down the screen.
* '''KEY {ON|OFF}''' turns the softkey Function key display of F1 to F10 at the bottom of the screen ON or OFF.
* '''Note: Soft key values cannot be assigned to KEY numbers 11 through 29 or an [[ERROR Codes|"Illegal Function call" error]] will occur!'''


''Example 1:'' Displaying the current '''KEY LIST''' string assignments to the Function keys.
{{CodeStart}} '' ''
{{Cl|KEY n|KEY}} 1, "Help"
{{Cl|KEY n|KEY}} 5, "Compile"
{{Cl|KEY n|KEY}} 10, "Quit"
{{Cl|PRINT}} "Press any key!"
K$ = {{Cl|INPUT$}}(1)
{{Cl|KEY LIST}}
{{Cl|END}} '' ''
{{CodeEnd}}
{{OutputStart}}Press any key!
F1  Help
F2
F3
F4
F5  Compile
F6
F7
F8
F9
F10 Quit
F11
F12
{{OutputEnd}}


''Example 2:'' Displaying the function key assignments for F1 to F10 at the bottom of the screen with '''KEY ON''' and '''KEY OFF'''.
{{CodeStart}} '' ''
{{Cl|KEY n|KEY}} 1, "Help" + {{Cl|CHR$}}(13)    'add Return character to complete the input
{{Cl|KEY n|KEY}} 5, "Compile" + {{Cl|CHR$}}(13)
{{Cl|KEY n|KEY}} 10, "Quit" + {{Cl|CHR$}}(13)
'''KEY ON'''
DO
{{Cl|INPUT}} "Press F10 to turn display off! ", M$
LOOP UNTIL M$ = "Quit"
'''KEY OFF'''
K$ = {{Cl|INPUT$}}(1)
{{Cl|KEY LIST}}
{{Cl|END}} '' ''
{{CodeEnd}}
{{OutputStart}}Press F10 to turn display off! Help
Press F10 to turn display off! Compile













1 {{WBG|Help←}}  2        3        4        5 {{WBG|Compil}}  6        7        8        9        10 {{WBG|Quit←}}
{{OutputEnd}}
:''Explanation:'' The [[INPUT]] variable will hold the string value as if it was typed in and entered. "Quit" will KEY OFF bottom display.


''See also:'' 
* [[KEY n]], [[KEY(n)]], 
* [[ON KEY(n)]]
* [[_KEYHIT]], [[_KEYDOWN]]


{{PageNavigation}}