ncurses 6.0 - patch 20180106
[ncurses.git] / doc / html / man / curs_termattrs.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,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_termattrs.3x,v 1.13 2015/07/21 00:03:34 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 https://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">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_termattrs 3x</H1>
42 <PRE>
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>
44
45
46
47
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>, <STRONG>killwchar</STRONG>,
50        <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -  <STRONG>curses</STRONG>  environment  query
51        routines
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>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>
68
69
70 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71
72 </PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
73        The  <STRONG>baudrate</STRONG>  routine  returns  the output speed of the terminal.  The
74        number returned is in bits per second, for  example  <STRONG>9600</STRONG>,  and  is  an
75        integer.
76
77
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 character.
80
81        The  <STRONG>erasewchar</STRONG> routine stores the current erase character in the loca-
82        tion referenced by <EM>ch</EM>.  If no erase character  has  been  defined,  the
83        routine fails and the location referenced by <EM>ch</EM> is not changed.
84
85
86 </PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
87        The  <STRONG>has_ic</STRONG>  routine  is  true  if the terminal has insert- and delete-
88        character capabilities.
89
90        The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and  delete-line
91        capabilities, or can simulate them using scrolling regions.  This might
92        be used to determine if it would be appropriate  to  turn  on  physical
93        scrolling using <STRONG>scrollok</STRONG>.
94
95
96 </PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
97        The <STRONG>killchar</STRONG> routine returns the user's current line kill character.
98
99        The  <STRONG>killwchar</STRONG>  routine  stores  the current line-kill character in the
100        location referenced by <EM>ch</EM>.  If no line-kill character has been defined,
101        the routine fails and the location referenced by <EM>ch</EM> is not changed.
102
103
104 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
105        The  <STRONG>longname</STRONG>  routine  returns a pointer to a static area containing a
106        verbose description of the current terminal.  The maximum length  of  a
107        verbose  description  is  128 characters.  It is defined only after the
108        call to <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.  The area is overwritten by  each  call  to
109        <STRONG>newterm</STRONG>  and  is not restored by <STRONG>set_term</STRONG>, so the value should be saved
110        between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be used with  multiple
111        terminals.
112
113
114 </PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
115        If a given terminal does not support a video attribute that an applica-
116        tion program is trying to use, <STRONG>curses</STRONG> may substitute a different  video
117        attribute for it.  The <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a log-
118        ical <STRONG>OR</STRONG> of all video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG>  and
119        <EM>WA</EM><STRONG>_</STRONG>  constants  respectively.  This information is useful when a <STRONG>curses</STRONG>
120        program needs complete control over the appearance of the screen.
121
122
123 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
124        The <STRONG>termname</STRONG> routine returns the terminal name used by <STRONG>setupterm</STRONG>.
125
126
127 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
128        <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
129
130        Routines that return an integer return <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  (SVr4
131        only  specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful com-
132        pletion.
133
134
135 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
136        Note that <STRONG>termattrs</STRONG> may be a macro.
137
138
139 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
140        The XSI Curses standard, Issue 4 describes these functions.  It changes
141        the  return type of <STRONG>termattrs</STRONG> to the new type <STRONG>attr_t</STRONG>.  Most versions of
142        curses truncate the result returned by <STRONG>termname</STRONG> to 14 characters.
143
144
145 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
146        <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>
147
148
149
150                                                             <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
151 </PRE>
152 <div class="nav">
153 <ul>
154 <li><a href="#h2-NAME">NAME</a></li>
155 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
156 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
157 <ul>
158 <li><a href="#h3-baudrate">baudrate</a></li>
159 <li><a href="#h3-erasechar_-erasewchar">erasechar, erasewchar</a></li>
160 <li><a href="#h3-has_is_-has_il">has_is, has_il</a></li>
161 <li><a href="#h3-killchar_-killwchar">killchar, killwchar</a></li>
162 <li><a href="#h3-longname">longname</a></li>
163 <li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</a></li>
164 <li><a href="#h3-termname">termname</a></li>
165 </ul>
166 </li>
167 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
168 <li><a href="#h2-NOTES">NOTES</a></li>
169 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
170 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
171 </ul>
172 </div>
173 </BODY>
174 </HTML>