doc/html/man/curs_variables.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2010-2013,2015 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_variables.3x,v 1.8 2015/08/22 23:33:22 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_variables 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1 class="no-header">curs_variables 3x</H1>
  42 <PRE>
  43 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>                                   <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  49        <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>,
  50        <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
  57        <STRONG>int</STRONG> <STRONG>COLORS;</STRONG>
  58        <STRONG>int</STRONG> <STRONG>COLS;</STRONG>
  59        <STRONG>int</STRONG> <STRONG>ESCDELAY;</STRONG>
  60        <STRONG>int</STRONG> <STRONG>LINES;</STRONG>
  61        <STRONG>int</STRONG> <STRONG>TABSIZE;</STRONG>
  62        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>curscr;</STRONG>
  63        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newscr;</STRONG>
  64        <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
  65
  66
  67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  68        This page summarizes variables provided by the <STRONG>curses</STRONG>  li-
  69        brary.   A more complete description is given in the <STRONG>curs-</STRONG>
  70        <STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page.
  71
  72        Depending on the configuration, these may be actual  vari-
  73        ables,     or    macros    (see    <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>    and
  74        <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>) which provide read-only access  to  <EM>curs-</EM>
  75        <EM>es</EM>'s  state.   In  either  case, applications should treat
  76        them as read-only to avoid confusing the library.
  77
  78
  79 </PRE><H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
  80        After initializing curses, this variable contains the num-
  81        ber of color pairs which the terminal can support.  Usual-
  82        ly the number of color pairs  will  be  the  product  <STRONG>COL-</STRONG>
  83        <STRONG>ORS</STRONG>*<STRONG>COLORS</STRONG>, however this is not always true:
  84
  85        <STRONG>o</STRONG>   a  few  terminals  use HLS colors, which do not follow
  86            this rule
  87
  88        <STRONG>o</STRONG>   terminals supporting a large number of colors are lim-
  89            ited  by  the number of color pairs that can be repre-
  90            sented in a <EM>signed</EM> <EM>short</EM> value.
  91
  92
  93 </PRE><H3><a name="h3-COLORS">COLORS</a></H3><PRE>
  94        After initializing curses, this variable contains the num-
  95        ber of colors which the terminal can support.
  96
  97
  98 </PRE><H3><a name="h3-COLS">COLS</a></H3><PRE>
  99        After  initializing  curses,  this  variable  contains the
 100        width of the screen, i.e., the number of columns.
 101
 102
 103 </PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
 104        This variable holds the number of milliseconds to wait af-
 105        ter reading an escape character, to distinguish between an
 106        individual escape character entered on the  keyboard  from
 107        escape  sequences  sent  by cursor- and function-keys (see
 108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 109
 110
 111 </PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>
 112        After initializing  curses,  this  variable  contains  the
 113        height of the screen, i.e., the number of lines.
 114
 115
 116 </PRE><H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
 117        This  variable  holds  the  number  of columns used by the
 118        <EM>curses</EM> library when converting a tab character  to  spaces
 119        as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
 120
 121
 122 </PRE><H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
 123        This implementation of curses uses a special window <STRONG>curscr</STRONG>
 124        to record its updates to the terminal screen.
 125
 126
 127 </PRE><H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
 128        This implementation of curses uses a special window <STRONG>newscr</STRONG>
 129        to  hold  updates  to  the terminal screen before applying
 130        them to <STRONG>curscr</STRONG>.
 131
 132
 133 </PRE><H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
 134        Upon initializing curses, a default window called  <STRONG>stdscr</STRONG>,
 135        which  is  the  size  of  the terminal screen, is created.
 136        Many curses functions use this window.
 137
 138
 139 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 140        The   curses   library   is   initialized   using   either
 141        <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, or <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>.
 142
 143        If  <STRONG>curses</STRONG>  is  configured to use separate curses/terminfo
 144        libraries, most of these variables reside  in  the  curses
 145        library.
 146
 147
 148 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 149        ESCDELAY  and TABSIZE are extensions, not provided in most
 150        other implementations of curses.
 151
 152        ESCDELAY is an extension in AIX curses:
 153
 154        <STRONG>o</STRONG>   In AIX, the units for ESCDELAY are <EM>fifths</EM>  of  a  mil-
 155            lisecond.
 156
 157        <STRONG>o</STRONG>   The default value for AIX's ESCDELAY is 0.1 seconds.
 158
 159        <STRONG>o</STRONG>   AIX also enforces a limit of 10,000 seconds for ESCDE-
 160            LAY; this implementation currently has no upper limit.
 161
 162        This implementation has long used ESCDELAY with  units  of
 163        milliseconds,  making  it impossible to be completely com-
 164        patible with AIX.  Likewise, most users have either decid-
 165        ed to override the value, or rely upon its default value.
 166
 167
 168 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 169        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,       <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>,      <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>,
 170        <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 171
 172
 173
 174                                                      <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 175 </PRE>
 176 <div class="nav">
 177 <ul>
 178 <li><a href="#h2-NAME">NAME</a></li>
 179 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 180 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 181 <ul>
 182 <li><a href="#h3-COLOR_PAIRS">COLOR_PAIRS</a></li>
 183 <li><a href="#h3-COLORS">COLORS</a></li>
 184 <li><a href="#h3-COLS">COLS</a></li>
 185 <li><a href="#h3-ESCDELAY">ESCDELAY</a></li>
 186 <li><a href="#h3-LINES">LINES</a></li>
 187 <li><a href="#h3-TABSIZE">TABSIZE</a></li>
 188 <li><a href="#h3-The-Current-Screen">The Current Screen</a></li>
 189 <li><a href="#h3-The-New-Screen">The New Screen</a></li>
 190 <li><a href="#h3-The-Standard-Screen">The Standard Screen</a></li>
 191 </ul>
 192 </li>
 193 <li><a href="#h2-NOTES">NOTES</a></li>
 194 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 195 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 196 </ul>
 197 </div>
 198 </BODY>
 199 </HTML>