X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fkeyok.3x.html;h=41a419c6ddb200f581284216d98b83ab7d759866;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=a50ae40276a7e478affeb43ba4f7ee58ab5feeb0;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40;p=ncurses.git diff --git a/doc/html/man/keyok.3x.html b/doc/html/man/keyok.3x.html index a50ae402..41a419c6 100644 --- a/doc/html/man/keyok.3x.html +++ b/doc/html/man/keyok.3x.html @@ -1,6 +1,7 @@ -
- --keyok(3x) keyok(3x) +keyok(3x) Library calls keyok(3x)
- keyok - enable or disable a keycode + keyok - enable or disable a curses function key code
#include <curses.h> - int keyok(int keycode, bool enable); + int keyok(int key-code, bool bf);
- 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.
- 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. + + +
+ keyok 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 keyok. -
- define_key(3x). +
+ Thomas Dickey -
- Thomas Dickey. + +
+ curses(3x), define_key(3x), keybound(3x), keyok(3x), key_defined(3x) - keyok(3x) +ncurses 6.5 2024-06-15 keyok(3x)