| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
|
|---|
| 3 | .\" *
|
|---|
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 5 | .\" copy of this software and associated documentation files (the *
|
|---|
| 6 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 9 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 10 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 11 | .\" *
|
|---|
| 12 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 13 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 14 | .\" *
|
|---|
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 22 | .\" *
|
|---|
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 24 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 25 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 26 | .\" authorization. *
|
|---|
| 27 | .\"***************************************************************************
|
|---|
| 28 | .\"
|
|---|
| 29 | .\" Author: Thomas E. Dickey 1997
|
|---|
| 30 | .\"
|
|---|
| 31 | .\" $Id: keyok.3x,v 1.8 2003/10/25 20:41:08 tom Exp $
|
|---|
| 32 | .TH keyok 3X ""
|
|---|
| 33 | .SH NAME
|
|---|
| 34 | \fBkeyok\fP \- enable or disable a keycode
|
|---|
| 35 | .SH SYNOPSIS
|
|---|
| 36 | \fB#include <curses.h>\fP
|
|---|
| 37 |
|
|---|
| 38 | \fBint keyok(int keycode, bool enable);\fP
|
|---|
| 39 | .SH DESCRIPTION
|
|---|
| 40 | This is an extension to the curses library.
|
|---|
| 41 | It permits an application to disable specific keycodes, rather than
|
|---|
| 42 | use the \fIkeypad\fP function to disable all keycodes.
|
|---|
| 43 | Keys that have been disabled can be reenabled.
|
|---|
| 44 | .SH RETURN VALUE
|
|---|
| 45 | The keycode must be greater than zero, else ERR is returned.
|
|---|
| 46 | If it does not correspond to a defined key, then ERR is returned.
|
|---|
| 47 | If the \fIenable\fP parameter is true, then the key must have been disabled,
|
|---|
| 48 | and vice versa.
|
|---|
| 49 | Otherwise, the function returns OK.
|
|---|
| 50 | .SH PORTABILITY
|
|---|
| 51 | These routines are specific to ncurses. They were not supported on
|
|---|
| 52 | Version 7, BSD or System V implementations. It is recommended that
|
|---|
| 53 | any code depending on them be conditioned using NCURSES_VERSION.
|
|---|
| 54 | .SH SEE ALSO
|
|---|
| 55 | \fBdefine_key\fR(3X).
|
|---|
| 56 | .SH AUTHOR
|
|---|
| 57 | Thomas Dickey.
|
|---|
| 58 | .\"#
|
|---|
| 59 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 60 | .\"# Local Variables:
|
|---|
| 61 | .\"# mode:nroff
|
|---|
| 62 | .\"# fill-column:79
|
|---|
| 63 | .\"# End:
|
|---|
