X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=9ebd9c8836f51dbbb4c0a297f38e22de379f63ed;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=b9316c00042e892eebb271b6c26324776f5bf3d6;hpb=894a177fd5228cdbe790bd1dc9435bd435c29681;p=ncurses.git diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index b9316c00..9ebd9c88 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,6 +1,6 @@
-define_key(3x) Library calls define_key(3x) @@ -48,49 +48,59 @@
- define_key - define a curses 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 interpret 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 definition is NULL, any existing one 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.
- Either keycode must be greater than zero, or definition must be 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 + + o insufficient memory is available to bind definition to key-code. + + Otherwise, define_key returns OK. + + +
+ define_key is an ncurses extension.
- 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 conditioned using NCURSES_VERSION. + 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
- keyok(3x), key_defined(3x) + curses(3x), keybound(3x), keyok(3x), key_defined(3x), terminfo(5) -ncurses 6.4 2023-10-07 define_key(3x) +ncurses 6.5 2024-06-08 define_key(3x)