doc/html/man/define_key.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * Author: Thomas E. Dickey 1997
  31   * @Id: define_key.3x,v 1.44 2024/05/18 20:04:21 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>define_key 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">define_key 3x 2024-05-18 ncurses 6.5 Library calls</H1>
  44 <PRE>
  45 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>define_key</STRONG> - define a <EM>curses</EM> function key code
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>define_key(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>definition</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>key-code</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        The <STRONG>define_key</STRONG> <EM>ncurses</EM> extension permits a <EM>curses</EM> application to <EM>bind</EM> a
  62        string <EM>definition</EM> to the function key <EM>key-code</EM> returned  by  <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>
  63        (wide-character  API users: <STRONG><A HREF="curs_get_wch.3x.html">wget_wch(3x)</A></STRONG>) when <STRONG><A HREF="curs_inopts.3x.html">keypad(3x)</A></STRONG> is enabled in
  64        a window and a function key is  pressed.   <EM>ncurses</EM>  interprets  such  a
  65        binding  as  it  does  those  in  the  <EM>terminfo</EM>  database entry for the
  66        terminal type.
  67
  68        A <EM>definition</EM> of <STRONG>NULL</STRONG> removes any existing one <EM>key-code</EM>.   Similarly,  a
  69        non-positive <EM>key-code</EM> removes any existing bindings for <EM>definition</EM>.
  70
  71
  72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  73        <STRONG>define_key</STRONG> returns <STRONG>ERR</STRONG> if
  74
  75        <STRONG>o</STRONG>   <EM>definition</EM> is <STRONG>NULL</STRONG> and <EM>key-code</EM> is nonpositive, or
  76
  77        <STRONG>o</STRONG>   insufficient memory is available to bind <EM>definition</EM> to <EM>key-code</EM>.
  78
  79        Otherwise, <STRONG>define_key</STRONG> returns <STRONG>OK</STRONG>.
  80
  81
  82 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
  83        <STRONG>define_key</STRONG> is an <EM>ncurses</EM> extension.
  84
  85
  86 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  87        Applications employing <EM>ncurses</EM> extensions should condition their use on
  88        the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
  89
  90        NetBSD <EM>curses</EM> since 2.0 (2004) supports <STRONG>define_key</STRONG>.
  91
  92
  93 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  94        Thomas Dickey
  95
  96
  97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  98        <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  <STRONG><A HREF="keyok.3x.html">keyok(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>,
  99        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 100
 101
 102
 103 ncurses 6.5                       2024-05-18                    <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>
 104 </PRE>
 105 <div class="nav">
 106 <ul>
 107 <li><a href="#h2-NAME">NAME</a></li>
 108 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 109 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 110 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 111 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
 112 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 113 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 114 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 115 </ul>
 116 </div>
 117 </BODY>
 118 </HTML>