ncurses 6.2 - patch 20210619
[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 <B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>                                          <B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>baudrate</B>,  <B>erasechar</B>,  <B>erasewchar</B>, <B>has_ic</B>, <B>has_il</B>, <B>killchar</B>, <B>killwchar</B>,
51        <B>longname</B>, <B>term_attrs</B>, <B>termattrs</B>, <B>termname</B> -  <B>curses</B>  environment  query
52        routines
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <B>#include</B> <B>&lt;curses.h&gt;</B>
57
58        <B>int</B> <B>baudrate(void);</B>
59        <B>char</B> <B>erasechar(void);</B>
60        <B>int</B> <B>erasewchar(wchar_t</B> <B>*</B><I>ch</I><B>);</B>
61        <B>bool</B> <B>has_ic(void);</B>
62        <B>bool</B> <B>has_il(void);</B>
63        <B>char</B> <B>killchar(void);</B>
64        <B>int</B> <B>killwchar(wchar_t</B> <B>*</B><I>ch</I><B>);</B>
65        <B>char</B> <B>*longname(void);</B>
66        <B>attr_t</B> <B>term_attrs(void);</B>
67        <B>chtype</B> <B>termattrs(void);</B>
68        <B>char</B> <B>*termname(void);</B>
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  <B>baudrate</B>  routine  returns  the output speed of the terminal.  The
75        number returned is in bits per second, for  example  <B>9600</B>,  and  is  an
76        integer.
77
78
79 </PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
80        The <B>erasechar</B> routine returns the user's current erase character.
81
82        The  <B>erasewchar</B>  routine  stores  the  current  erase  character in the
83        location referenced by <I>ch</I>.  If no erase character has been defined, the
84        routine fails and the location referenced by <I>ch</I> is not changed.
85
86
87 </PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
88        The  <B>has_ic</B>  routine  is  true  if the terminal has insert- and delete-
89        character capabilities.
90
91        The <B>has_il</B> 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 <B>scrollok</B>.
95
96
97 </PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
98        The <B>killchar</B> routine returns the user's current line kill character.
99
100        The  <B>killwchar</B>  routine  stores  the current line-kill character in the
101        location referenced by <I>ch</I>.  If no line-kill character has been defined,
102        the routine fails and the location referenced by <I>ch</I> is not changed.
103
104
105 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
106        The  <B>longname</B>  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 <B>initscr</B> or <B>newterm</B>.  The area is overwritten by  each  call  to
110        <B>newterm</B>  and  is not restored by <B>set_term</B>, so the value should be saved
111        between calls to <B>newterm</B> if <B>longname</B> 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
117        application program is trying to use, <B>curses</B> may substitute a different
118        video  attribute for it.  The <B>termattrs</B> and <B>term_attrs</B> functions return
119        a logical <B>OR</B> of all video attributes supported by the terminal using <I>A</I><B>_</B>
120        and  <I>WA</I><B>_</B>  constants  respectively.   This  information is useful when a
121        <B>curses</B> program needs  complete  control  over  the  appearance  of  the
122        screen.
123
124
125 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
126        The <B>termname</B> routine returns the terminal name used by <B>setupterm</B>.
127
128
129 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
130        <B>longname</B> and <B>termname</B> return <B>NULL</B> on error.
131
132        Routines  that  return  an integer return <B>ERR</B> upon failure and <B>OK</B> (SVr4
133        only specifies "an integer  value  other  than  <B>ERR</B>")  upon  successful
134        completion.
135
136
137 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
138        Note that <B>termattrs</B> may be a macro.
139
140
141 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
142        The XSI Curses standard, Issue 4 describes these functions.  It changes
143        the return type of <B>termattrs</B> to the new type <B>attr_t</B>.  Most versions  of
144        curses truncate the result returned by <B>termname</B> to 14 characters.
145
146
147 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
148        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_initscr.3X.html">curs_initscr(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>
149
150
151
152                                                             <B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>
153 </PRE>
154 <div class="nav">
155 <ul>
156 <li><a href="#h2-NAME">NAME</a></li>
157 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
158 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
159 <ul>
160 <li><a href="#h3-baudrate">baudrate</a></li>
161 <li><a href="#h3-erasechar_-erasewchar">erasechar, erasewchar</a></li>
162 <li><a href="#h3-has_is_-has_il">has_is, has_il</a></li>
163 <li><a href="#h3-killchar_-killwchar">killchar, killwchar</a></li>
164 <li><a href="#h3-longname">longname</a></li>
165 <li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</a></li>
166 <li><a href="#h3-termname">termname</a></li>
167 </ul>
168 </li>
169 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
170 <li><a href="#h2-NOTES">NOTES</a></li>
171 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
172 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
173 </ul>
174 </div>
175 </BODY>
176 </HTML>