<!--
****************************************************************************
- * Copyright 2018-2022,2023 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1999-2008,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* authorization. *
****************************************************************************
* Author: Thomas E. Dickey 1999
- * @Id: keybound.3x,v 1.33 2023/11/25 14:26:30 tom Exp @
+ * @Id: keybound.3x,v 1.38 2024/05/18 20:05:36 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>keybound 3x 2023-11-25 ncurses 6.4 Library calls</TITLE>
+<TITLE>keybound 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">keybound 3x 2023-11-25 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">keybound 3x 2024-05-18 ncurses 6.5 Library calls</H1>
<PRE>
<STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> Library calls <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>keybound</STRONG> - get definition of <EM>curses</EM> keycode
+ <STRONG>keybound</STRONG> - get definition of 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>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <EM>keycode</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>count</EM><STRONG>);</STRONG>
+ <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <EM>key-code</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>count</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 determine the string which is defined in the terminfo for specific
- keycodes.
+ The <STRONG>keybound</STRONG> <EM>ncurses</EM> extension permits a <EM>curses</EM> application to obtain
+ the value of the string <EM>bound</EM> to the function key <EM>key-code</EM>; see
+ <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>). By default, such
+ bindings are string capabilities from the <EM>terminfo</EM> database entry
+ corresponding to the terminal type. The application can non-
+ destructively and repeatedly override such definitions with
+ <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, as if by pushing new definitions onto a stack. The
+ <EM>count</EM> parameter accesses the <EM>n</EM>th most recently defined binding; <STRONG>0</STRONG>
+ selects the binding that is used on input.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- The <EM>keycode</EM> parameter must be greater than zero, else <STRONG>NULL</STRONG> is returned.
- If it does not correspond to a defined key, then <STRONG>NULL</STRONG> is returned. The
- <EM>count</EM> parameter is used to allow the application to iterate through
- multiple definitions, counting from zero. When successful, the
- function returns a string which must be freed by the caller.
+ If <EM>key-code</EM> corresponds to a function key defined by the application or
+ the terminal type in use, <STRONG>keybound</STRONG> allocates and returns a string that
+ must be freed by the application. <STRONG>keybound</STRONG> returns <STRONG>NULL</STRONG> if <EM>key-code</EM> is
+ not positive or if it does not correspond to a key code definition.
+
+
+</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
+ <STRONG>keybound</STRONG> is an <EM>ncurses</EM> extension.
</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>.
+ 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-AUTHORS">AUTHORS</a></H2><PRE>
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
+ <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="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
-ncurses 6.
4 2023-11-25 <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
+ncurses 6.
5 2024-05-18 <STRONG><A HREF="keybound.3x.html">keybound(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>
projects / ncurses.git / blobdiff