X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fkeyok.3x.html;h=dbb3f0c1cca1d94d056d81801e032a61bc63ef9b;hb=HEAD;hp=4f76638b3ad5a2af061aeac5303b45b274ba2115;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d;p=ncurses.git diff --git a/doc/html/man/keyok.3x.html b/doc/html/man/keyok.3x.html index 4f76638b..e6d3a35e 100644 --- a/doc/html/man/keyok.3x.html +++ b/doc/html/man/keyok.3x.html @@ -1,6 +1,7 @@ - - -keyok 3x - - + +keyok 3x 2024-05-18 ncurses 6.5 Library calls + + -

keyok 3x

keyok 3x 2024-05-18 ncurses 6.5 Library calls

-keyok(3x)                                                     keyok(3x)
+keyok(3x)                        Library calls                       keyok(3x)

NAME

-       keyok - enable or disable a keycode
+       keyok - enable or disable a curses function key code

SYNOPSIS

        #include <curses.h>
 
-       int keyok(int keycode, bool enable);
+       int keyok(int key-code, bool bf);

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.
+       The  keyok  ncurses extension permits a curses application to disable a
+       function key key-code returned by wgetch(3x) (wide-character API users:
+       wget_wch(3x)).   Key  codes  that have been disabled can be re-enabled.
+       bf indicates the desired enablement status.   This  operation  is  more
+       fine-grained than calling keypad(3x), which affects all function keys.

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.
+       keyok returns ERR if
+
+       o   key-code is nonpositive,
+
+       o   key-code is not a recognized value, or
+
+       o   enablement of key-code is already in the desired state.
+
+       Otherwise, keyok returns OK.
+
+
+

EXTENSIONS

+       keyok is an ncurses extension.

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  con-
-       ditioned 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 keyok.
 
-

AUTHORS

+       Thomas Dickey
 
-

AUTHOR

-       Thomas Dickey.
+
+