<!--
****************************************************************************
- * Copyright 2018-2022,2023 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2010,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* authorization. *
****************************************************************************
* Author: Thomas E. Dickey 1997
- * @Id: keyok.3x,v 1.32 2023/09/23 22:49:51 tom Exp @
+ * @Id: keyok.3x,v 1.42 2024/05/18 20:06:09 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>keyok 3x 2023-09-23 ncurses 6.4 Library calls</TITLE>
+<TITLE>keyok 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">keyok 3x 2023-09-23 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">keyok 3x 2024-05-18 ncurses 6.5 Library calls</H1>
<PRE>
<STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> Library calls <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>keyok</STRONG> - enable or disable a <EM>curses</EM> keycode
+ <STRONG>keyok</STRONG> - enable or disable a <EM>curses</EM> function key code
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <EM>keycode</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>enable</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>keyok(int</STRONG> <EM>key-code</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>bf</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- This is an extension to the <EM>curses</EM> library. It permits an application
- to disable specific keycodes, rather than use the <STRONG>keypad</STRONG> function to
- disable all keycodes. Keys that have been disabled can be re-enabled.
+ The <STRONG>keyok</STRONG> <EM>ncurses</EM> extension permits a <EM>curses</EM> application to disable a
+ function key <EM>key-code</EM> returned by <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> (wide-character API users:
+ <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG>). Key codes that have been disabled can be re-enabled.
+ <EM>bf</EM> indicates the desired enablement status. This operation is more
+ fine-grained than calling <STRONG><A HREF="curs_inopts.3x.html">keypad(3x)</A></STRONG>, which affects <EM>all</EM> function keys.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The keycode must be greater than zero, else <STRONG>ERR</STRONG> is returned. If it
- does not correspond to a defined key, then <STRONG>ERR</STRONG> is returned. If the
- <EM>enable</EM> parameter is true, then the key must have been disabled, and
- vice versa. Otherwise, the function returns <STRONG>OK</STRONG>.
+ <STRONG>keyok</STRONG> returns <STRONG>ERR</STRONG> if
+ <STRONG>o</STRONG> <EM>key-code</EM> is nonpositive,
-</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- This routine is specific to <EM>ncurses</EM>. It was not supported on Version
- 7, BSD or System V implementations. It is recommended that any code
- depending on them be conditioned using <STRONG>NCURSES_VERSION</STRONG>.
+ <STRONG>o</STRONG> <EM>key-code</EM> is not a recognized value, or
+ <STRONG>o</STRONG> enablement of <EM>key-code</EM> is already in the desired state.
+
+ Otherwise, <STRONG>keyok</STRONG> returns <STRONG>OK</STRONG>.
-</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
+</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
+ <STRONG>keyok</STRONG> is an <EM>ncurses</EM> extension.
+
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ Applications employing <EM>ncurses</EM> extensions should condition their use on
+ the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
-</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
+ NetBSD <EM>curses</EM> since 2.0 (2004) supports <STRONG>keyok</STRONG>.
+
+
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Thomas Dickey
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>, <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>,
+
+
-ncurses 6.
4 2023-09-23 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
+ncurses 6.
5 2024-05-18 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<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-EXTENSIONS">EXTENSIONS</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
-<li><a href="#h2-AUTHOR">AUTHOR</a></li>
</ul>
</div>
</BODY>
projects / ncurses.git / blobdiff