2 ****************************************************************************
3 * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: curs_termattrs.3x,v 1.13 2015/07/21 00:03:34 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_termattrs 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">
41 <H1 class="no-header">curs_termattrs 3x</H1>
43 <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>,
50 <STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -
51 <STRONG>curses</STRONG> environment query routines
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>
58 <STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG>
59 <STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
60 <STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG>
61 <STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG>
62 <STRONG>char</STRONG> <STRONG>killchar(void);</STRONG>
63 <STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
64 <STRONG>char</STRONG> <STRONG>*longname(void);</STRONG>
65 <STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
66 <STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
67 <STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>
70 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72 </PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
73 The <STRONG>baudrate</STRONG> routine returns the output speed of the ter-
74 minal. The number returned is in bits per second, for
75 example <STRONG>9600</STRONG>, and is an integer.
78 </PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
79 The <STRONG>erasechar</STRONG> routine returns the user's current erase
82 The <STRONG>erasewchar</STRONG> routine stores the current erase character
83 in the location referenced by <EM>ch</EM>. If no erase character
84 has been defined, the routine fails and the location ref-
85 erenced by <EM>ch</EM> is not changed.
88 </PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
89 The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and
90 delete- character capabilities.
92 The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and
93 delete-line capabilities, or can simulate them using
94 scrolling regions. This might be used to determine if it
95 would be appropriate to turn on physical scrolling using
96 <STRONG>scrollok</STRONG>.
99 </PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
100 The <STRONG>killchar</STRONG> routine returns the user's current line kill
103 The <STRONG>killwchar</STRONG> routine stores the current line-kill charac-
104 ter in the location referenced by <EM>ch</EM>. If no line-kill
105 character has been defined, the routine fails and the
106 location referenced by <EM>ch</EM> is not changed.
109 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
110 The <STRONG>longname</STRONG> routine returns a pointer to a static area
111 containing a verbose description of the current terminal.
112 The maximum length of a verbose description is 128 charac-
113 ters. It is defined only after the call to <STRONG>initscr</STRONG> or
114 <STRONG>newterm</STRONG>. The area is overwritten by each call to <STRONG>newterm</STRONG>
115 and is not restored by <STRONG>set_term</STRONG>, so the value should be
116 saved between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be
117 used with multiple terminals.
120 </PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
121 If a given terminal does not support a video attribute
122 that an application program is trying to use, <STRONG>curses</STRONG> may
123 substitute a different video attribute for it. The <STRONG>ter-</STRONG>
124 <STRONG>mattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a logical <STRONG>OR</STRONG> of all
125 video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> and
126 <EM>WA</EM><STRONG>_</STRONG> constants respectively. This information is useful
127 when a <STRONG>curses</STRONG> program needs complete control over the
128 appearance of the screen.
131 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
132 The <STRONG>termname</STRONG> routine returns the terminal name used by
133 <STRONG>setupterm</STRONG>.
136 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
137 <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
139 Routines that return an integer return <STRONG>ERR</STRONG> upon failure
140 and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
141 <STRONG>ERR</STRONG>") upon successful completion.
144 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
145 Note that <STRONG>termattrs</STRONG> may be a macro.
148 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
149 The XSI Curses standard, Issue 4 describes these func-
150 tions. It changes the return type of <STRONG>termattrs</STRONG> to the new
151 type <STRONG>attr_t</STRONG>. Most versions of curses truncate the result
152 returned by <STRONG>termname</STRONG> to 14 characters.
155 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
156 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
160 <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
164 <li><a href="#h2-NAME">NAME</a></li>
165 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
166 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
168 <li><a href="#h3-baudrate">baudrate</a></li>
169 <li><a href="#h3-erasechar_-erasewchar">erasechar, erasewchar</a></li>
170 <li><a href="#h3-has_is_-has_il">has_is, has_il</a></li>
171 <li><a href="#h3-killchar_-killwchar">killchar, killwchar</a></li>
172 <li><a href="#h3-longname">longname</a></li>
173 <li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</a></li>
174 <li><a href="#h3-termname">termname</a></li>
177 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
178 <li><a href="#h2-NOTES">NOTES</a></li>
179 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
180 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>