define_key3x
Define a curses function key code
Usage
#include <curses.h>
int define_key(const char * definition, int key-code);
Overview
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.
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.
Return value
define_key returns ERR if
•
|
definition |
|---|---|
•
|
insufficient memory is available to bind definition |
Otherwise, define_key returns OK.
Extensions
define_key is an ncurses extension.
Portability
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.