Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_variables.3x.html
blob: 019c3e5b3762f9e52a5e1e21c4d36a6bf031165c [file] [log] [blame]
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]1<!--
2 ****************************************************************************
3 * Copyright (c) 2010,2013 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.6 2013/12/21 18:41:32 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>
49<H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>,
51 <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
52
53
54</PRE>
55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58 <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
59 <STRONG>int</STRONG> <STRONG>COLORS;</STRONG>
60 <STRONG>int</STRONG> <STRONG>COLS;</STRONG>
61 <STRONG>int</STRONG> <STRONG>ESCDELAY;</STRONG>
62 <STRONG>int</STRONG> <STRONG>LINES;</STRONG>
63 <STRONG>int</STRONG> <STRONG>TABSIZE;</STRONG>
64 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>curscr;</STRONG>
65 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newscr;</STRONG>
66 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
67
68
69</PRE>
70<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71 This page summarizes variables provided by the <STRONG>curses</STRONG> li-
72 brary. A more complete description is given in the <STRONG>curs-</STRONG>
73 <STRONG><A HREF="ncurses.3x.html">es(3x)</A></STRONG> manual page.
74
75 Depending on the configuration, these may be actual vari-
76 ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> and
77 <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>) which provide read-only access to <EM>curs-</EM>
78 <EM>es</EM>'s state. In either case, applications should treat
79 them as read-only to avoid confusing the library.
80
81
82</PRE>
83<H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
84 After initializing curses, this variable contains the num-
85 ber of color pairs which the terminal can support. Usual-
86 ly the number of color pairs will be the product <STRONG>COL-</STRONG>
87 <STRONG>ORS</STRONG>*<STRONG>COLORS</STRONG>, however this is not always true:
88
89 <STRONG>o</STRONG> a few terminals use HLS colors, which do not follow
90 this rule
91
92 <STRONG>o</STRONG> terminals supporting a large number of colors are lim-
93 ited by the number of color pairs that can be repre-
94 sented in a <EM>signed</EM> <EM>short</EM> value.
95
96
97</PRE>
98<H3><a name="h3-COLORS">COLORS</a></H3><PRE>
99 After initializing curses, this variable contains the num-
100 ber of colors which the terminal can support.
101
102
103</PRE>
104<H3><a name="h3-COLS">COLS</a></H3><PRE>
105 After initializing curses, this variable contains the
106 width of the screen, i.e., the number of columns.
107
108
109</PRE>
110<H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
111 This variable holds the number of milliseconds to wait af-
112 ter reading an escape character, to distinguish between an
113 individual escape character entered on the keyboard from
114 escape sequences sent by cursor- and function-keys (see
115 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
116
117
118</PRE>
119<H3><a name="h3-LINES">LINES</a></H3><PRE>
120 After initializing curses, this variable contains the
121 height of the screen, i.e., the number of lines.
122
123
124</PRE>
125<H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
126 This variable holds the number of columns used by the
127 <EM>curses</EM> library when converting a tab character to spaces
128 as it adds the tab to a window (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
129
130
131</PRE>
132<H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
133 This implementation of curses uses a special window <STRONG>curscr</STRONG>
134 to record its updates to the terminal screen.
135
136
137</PRE>
138<H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
139 This implementation of curses uses a special window <STRONG>newscr</STRONG>
140 to hold updates to the terminal screen before applying
141 them to <STRONG>curscr</STRONG>.
142
143
144</PRE>
145<H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
146 Upon initializing curses, a default window called <STRONG>stdscr</STRONG>,
147 which is the size of the terminal screen, is created.
148 Many curses functions use this window.
149
150
151</PRE>
152<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
153 The curses library is initialized using either
154 <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>.
155
156 If <STRONG>curses</STRONG> is configured to use separate curses/terminfo
157 libraries, most of these variables reside in the curses
158 library.
159
160
161</PRE>
162<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
163 ESCDELAY and TABSIZE are extensions, not provided in most
164 other implementations of curses.
165
166
167</PRE>
168<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>