doc/html/man/curs_extend.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018,2020 Thomas E. Dickey                                     *
   4   * Copyright 1999-2010,2016 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 1999-on
  31   * @Id: curs_extend.3x,v 1.24 2020/10/24 09:37:07 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>curs_extend 3x</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">curs_extend 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous curses extensions
  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>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <EM>enable</EM><STRONG>);</STRONG>
  59
  60
  61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  62        These  functions  are extensions to the curses library which do not fit
  63        easily into other categories.
  64
  65
  66 </PRE><H3><a name="h3-curses_version">curses_version</a></H3><PRE>
  67        Use <STRONG>curses_version</STRONG> to get the version number, including patch level  of
  68        the library, e.g., <STRONG>5.0.19991023</STRONG>
  69
  70
  71 </PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE>
  72        The  <STRONG>use_extended_names</STRONG>  function controls whether the calling applica-
  73        tion is able to use user-defined or nonstandard names which may be com-
  74        piled  into the terminfo description, i.e., via the terminfo or termcap
  75        interfaces.  Normally these names are  available  for  use,  since  the
  76        essential  decision  is  made  by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile
  77        extended terminal definitions.  However you can disable this feature to
  78        ensure compatibility with other implementations of curses.
  79
  80
  81 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  82        <STRONG>curses_version</STRONG>  returns a pointer to static memory; you should not free
  83        this in your application.
  84
  85        <STRONG>use_extended_names</STRONG> returns the previous state,  allowing  you  to  save
  86        this and restore it.
  87
  88
  89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  90        These  routines  are  specific  to ncurses.  They were not supported on
  91        Version 7, BSD or System V implementations.  It is recommended that any
  92        code depending on them be conditioned using NCURSES_VERSION.
  93
  94
  95 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  96        <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>,    <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>,    <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>,    <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>,
  97        <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>,    <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>,     <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>,     <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>,
  98        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
  99
 100
 101 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
 102        Thomas Dickey.
 103
 104
 105
 106                                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
 107 </PRE>
 108 <div class="nav">
 109 <ul>
 110 <li><a href="#h2-NAME">NAME</a></li>
 111 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 112 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 113 <ul>
 114 <li><a href="#h3-curses_version">curses_version</a></li>
 115 <li><a href="#h3-use_extended_names">use_extended_names</a></li>
 116 </ul>
 117 </li>
 118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 119 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 120 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 121 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
 122 </ul>
 123 </div>
 124 </BODY>
 125 </HTML>