X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=73332600044b708a779634a0238575fca3bc83e9;hb=HEAD;hp=e12d98990562f1ffeb4440706e3c2c4df4436ddf;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86;p=ncurses.git diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index e12d9899..8ca26d23 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,6 +1,7 @@ -
- --define_key(3x) define_key(3x) +define_key(3x) Library calls define_key(3x) --
- define_key - define a keycode +
+ define_key - define a curses function key code --
+
#include <curses.h> - int define_key(const char *definition, int keycode); + int define_key(const char * definition, int key-code); --
- This is an extension to the curses library. It permits an - application to define keycodes with their corresponding - control strings, so that the ncurses library will inter- - pret them just as it would the predefined codes in the - terminfo database. +
+ The define_key ncurses extension permits a curses application to bind a + string definition to the function key key-code returned by wgetch(3x) + (wide-character API users: wget_wch(3x)) when keypad(3x) is enabled in + a window and a function key is pressed. ncurses interprets such a + binding as it does those in the terminfo database entry for the + terminal type. - If the given string is null, any existing definition for - the keycode is removed. Similarly, if the given keycode - is negative or zero, any existing string for the given - definition is removed. + A definition of NULL removes any existing binding from key-code. + Similarly, a non-positive key-code removes an existing binding for + definition, if any. --
- The keycode must be greater than zero, and the string non- - null, otherwise ERR is returned. ERR may also be returned - if there is insufficient memory to allocate the data to - store the definition. If no error is detected, OK is - returned. +
+ define_key returns ERR if + o definition is NULL and key-code is nonpositive, or --
- These routines are specific to ncurses. They were not - supported on Version 7, BSD or System V implementations. - It is recommended that any code depending on them be con- - ditioned using NCURSES_VERSION. + o insufficient memory is available to bind definition to key-code. + Otherwise, define_key returns OK. --
- keyok(3x), key_defined(3x). +
+ define_key is an ncurses extension. --
- Thomas Dickey. + +
+ Applications employing ncurses extensions should condition their use on + the visibility of the NCURSES_VERSION preprocessor macro. + + NetBSD curses since 2.0 (2004) supports define_key. + + +
+ Thomas Dickey + + +
+ ncurses(3x), keyok(3x), key_defined(3x), keybound(3x), keyok(3x), + terminfo(5) - define_key(3x) +ncurses 6.5 2024-05-25 define_key(3x)