ncursesw-morphos/doc/html/man/keyok.3x.html

105 lines
4.8 KiB
HTML
Raw Normal View History

2002-10-13 11:35:53 +08:00
<!--
****************************************************************************
* Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
2002-10-13 11:35:53 +08:00
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
2004-02-09 10:15:26 +08:00
* Author: Thomas E. Dickey 1997
* @Id: keyok.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
2002-10-13 11:35:53 +08:00
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1998-03-01 12:21:12 +08:00
<HTML>
2002-10-13 11:35:53 +08:00
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
2002-10-13 11:35:53 +08:00
<TITLE>keyok 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
1999-10-24 12:32:42 +08:00
<BODY>
<H1 class="no-header">keyok 3x</H1>
1998-03-01 12:21:12 +08:00
<PRE>
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
2004-02-09 10:15:26 +08:00
2000-07-09 10:46:08 +08:00
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>keyok</STRONG> - enable or disable a keycode
1998-03-01 12:21:12 +08:00
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
1998-03-01 12:21:12 +08:00
2002-10-13 11:35:53 +08:00
<STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <STRONG>keycode,</STRONG> <STRONG>bool</STRONG> <STRONG>enable);</STRONG>
1998-03-01 12:21:12 +08:00
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
1998-03-01 12:21:12 +08:00
This is an extension to the curses library. It permits an
application to disable specific keycodes, rather than use
2002-10-13 11:35:53 +08:00
the <EM>keypad</EM> function to disable all keycodes. Keys that
have been disabled can be re-enabled.
1998-03-01 12:21:12 +08:00
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
1998-03-01 12:21:12 +08:00
The keycode must be greater than zero, else ERR is
returned. If it does not correspond to a defined key,
2002-10-13 11:35:53 +08:00
then ERR is returned. If the <EM>enable</EM> parameter is true,
1998-03-01 12:21:12 +08:00
then the key must have been disabled, and vice versa.
Otherwise, the function returns OK.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
1998-03-01 12:21:12 +08:00
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.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
2002-10-13 11:35:53 +08:00
<STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>.
1998-03-01 12:21:12 +08:00
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
1998-03-01 12:21:12 +08:00
Thomas Dickey.
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
1998-03-01 12:21:12 +08:00
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-AUTHOR">AUTHOR</a></li>
</ul>
</div>
1998-03-01 12:21:12 +08:00
</BODY>
</HTML>