2 ****************************************************************************
3 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************
29 * Author: Thomas E. Dickey 1997
30 * @Id: keyok.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>keyok 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
45 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
52 <STRONG>keyok</STRONG> - enable or disable a keycode
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
59 <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
63 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 This is an extension to the curses library. It permits an
65 application to disable specific keycodes, rather than use
66 the <EM>keypad</EM> function to disable all keycodes. Keys that
67 have been disabled can be re-enabled.
71 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72 The keycode must be greater than zero, else ERR is
73 returned. If it does not correspond to a defined key,
74 then ERR is returned. If the <EM>enable</EM> parameter is true,
75 then the key must have been disabled, and vice versa.
76 Otherwise, the function returns OK.
80 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
81 These routines are specific to ncurses. They were not
82 supported on Version 7, BSD or System V implementations.
83 It is recommended that any code depending on them be con-
84 ditioned using NCURSES_VERSION.
88 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
89 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
93 <H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
98 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
102 <li><a href="#h2-NAME">NAME</a></li>
103 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
104 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
105 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
108 <li><a href="#h2-AUTHOR">AUTHOR</a></li>