ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_termattrs.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2010,2015 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   * @Id: curs_termattrs.3x,v 1.15 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_termattrs 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_termattrs 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>                                          <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>baudrate</STRONG>,  <STRONG>erasechar</STRONG>,  <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>, <STRONG>killwchar</STRONG>,
51        <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -  <STRONG>curses</STRONG>  environment  query
52        routines
53
54
55 </PRE><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>baudrate(void);</STRONG>
59        <STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG>
60        <STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
61        <STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG>
62        <STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG>
63        <STRONG>char</STRONG> <STRONG>killchar(void);</STRONG>
64        <STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
65        <STRONG>char</STRONG> <STRONG>*longname(void);</STRONG>
66        <STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
67        <STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
68        <STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>
69
70
71 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
72
73 </PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
74        The  <STRONG>baudrate</STRONG>  routine  returns  the output speed of the terminal.  The
75        number returned is in bits per second, for  example  <STRONG>9600</STRONG>,  and  is  an
76        integer.
77
78
79 </PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
80        The <STRONG>erasechar</STRONG> routine returns the user's current erase character.
81
82        The  <STRONG>erasewchar</STRONG> routine stores the current erase character in the loca-
83        tion referenced by <EM>ch</EM>.  If no erase character  has  been  defined,  the
84        routine fails and the location referenced by <EM>ch</EM> is not changed.
85
86
87 </PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
88        The  <STRONG>has_ic</STRONG>  routine  is  true  if the terminal has insert- and delete-
89        character capabilities.
90
91        The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and  delete-line
92        capabilities, or can simulate them using scrolling regions.  This might
93        be used to determine if it would be appropriate  to  turn  on  physical
94        scrolling using <STRONG>scrollok</STRONG>.
95
96
97 </PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
98        The <STRONG>killchar</STRONG> routine returns the user's current line kill character.
99
100        The  <STRONG>killwchar</STRONG>  routine  stores  the current line-kill character in the
101        location referenced by <EM>ch</EM>.  If no line-kill character has been defined,
102        the routine fails and the location referenced by <EM>ch</EM> is not changed.
103
104
105 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
106        The  <STRONG>longname</STRONG>  routine  returns a pointer to a static area containing a
107        verbose description of the current terminal.  The maximum length  of  a
108        verbose  description  is  128 characters.  It is defined only after the
109        call to <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.  The area is overwritten by  each  call  to
110        <STRONG>newterm</STRONG>  and  is not restored by <STRONG>set_term</STRONG>, so the value should be saved
111        between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be used with  multiple
112        terminals.
113
114
115 </PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
116        If a given terminal does not support a video attribute that an applica-
117        tion program is trying to use, <STRONG>curses</STRONG> may substitute a different  video
118        attribute for it.  The <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a log-
119        ical <STRONG>OR</STRONG> of all video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG>  and
120        <EM>WA</EM><STRONG>_</STRONG>  constants  respectively.  This information is useful when a <STRONG>curses</STRONG>
121        program needs complete control over the appearance of the screen.
122
123
124 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
125        The <STRONG>termname</STRONG> routine returns the terminal name used by <STRONG>setupterm</STRONG>.
126
127
128 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
129        <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
130
131        Routines that return an integer return <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  (SVr4
132        only  specifies "an integer value other than <STRONG>ERR</STRONG>") upon successful com-
133        pletion.
134
135
136 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
137        Note that <STRONG>termattrs</STRONG> may be a macro.
138
139
140 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
141        The XSI Curses standard, Issue 4 describes these functions.  It changes
142        the  return type of <STRONG>termattrs</STRONG> to the new type <STRONG>attr_t</STRONG>.  Most versions of
143        curses truncate the result returned by <STRONG>termname</STRONG> to 14 characters.
144
145
146 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
147        <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>
148
149
150
151                                                             <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
152 </PRE>
153 <div class="nav">
154 <ul>
155 <li><a href="#h2-NAME">NAME</a></li>
156 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
157 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
158 <ul>
159 <li><a href="#h3-baudrate">baudrate</a></li>
160 <li><a href="#h3-erasechar_-erasewchar">erasechar, erasewchar</a></li>
161 <li><a href="#h3-has_is_-has_il">has_is, has_il</a></li>
162 <li><a href="#h3-killchar_-killwchar">killchar, killwchar</a></li>
163 <li><a href="#h3-longname">longname</a></li>
164 <li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</a></li>
165 <li><a href="#h3-termname">termname</a></li>
166 </ul>
167 </li>
168 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
169 <li><a href="#h2-NOTES">NOTES</a></li>
170 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
171 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
172 </ul>
173 </div>
174 </BODY>
175 </HTML>