keyok(3ncurses) [plan9 man page]

keyok(3NCURSES) 														   keyok(3NCURSES)

NAME

       keyok - enable or disable a keycode

SYNOPSIS

       #include <curses.h>

       int keyok(int keycode, bool enable);

DESCRIPTION

       This is an extension to the curses library.  It permits an application to disable specific keycodes, rather than use the keypad function to
       disable all keycodes.  Keys that have been disabled can be re-enabled.

RETURN VALUE

       The keycode must be greater than zero, else ERR is returned.  If it does not correspond to a defined key, then ERR  is  returned.   If  the
       enable parameter is true, then the key must have been disabled, and vice versa.	Otherwise, the function returns OK.

PORTABILITY

       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.

SEE ALSO

       define_key(3NCURSES).

AUTHOR

       Thomas Dickey.

																   keyok(3NCURSES)

define_key(3NCURSES)													      define_key(3NCURSES)

NAME

       define_key - define a keycode

SYNOPSIS

       #include <curses.h>

       int define_key(const char *definition, int keycode);

DESCRIPTION

       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.

       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.

RETURN VALUE

       The  keycode  must be greater than zero, and the string non-null, otherwise ERR is returned.  ERR may also be returned if there is insuffi-
       cient memory to allocate the data to store the definition.  If no error is detected, OK is returned.

PORTABILITY

       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.

SEE ALSO

       keyok(3NCURSES), key_defined(3NCURSES).

AUTHOR

       Thomas Dickey.

															      define_key(3NCURSES)