mirror/ncursesw-morphos
2
0
Fork 0
mirror of https://github.com/Aigor44/ncursesw-morphos.git synced 2025-01-24 15:13:56 +08:00
Code Issues Packages Projects Releases Wiki Activity
aabb3a65ee
ncursesw-morphos/doc/html/man/curs_termattrs.3x.html

168 lines
8.5 KiB
HTML
Raw Normal View History

ncurses 5.3
2002-10-13 11:35:53 +08:00
<!--
****************************************************************************
ncurses 5.7 - patch 20100731 + modify initialization check for win32con driver to eliminate need for special case for TERM "unknown", using terminal database if available (prompted by discussion with Roumen Petrov). + for MinGW port, ensure that terminal driver is setup if tgetent() is called (patch by Roumen Petrov). + document tabs "-0" and "-8" options in manpage. + fix Debian "lintian" issues with manpages reported in http://lintian.debian.org/full/csmall@debian.org.html#ncurses
2010-08-01 08:45:28 +08:00
* Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. *
ncurses 5.3
2002-10-13 11:35:53 +08:00
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* "Software"), to deal in the Software without restriction, including *
* without limitation the rights to use, copy, modify, merge, publish, *
* distribute, distribute with modifications, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included *
* in all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
* *
* Except as contained in this notice, the name(s) of the above copyright *
* holders shall not be used in advertising or otherwise to promote the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
ncurses 5.7 - patch 20110108 + regenerated html manpages. + minor fixes to enable lint when trace is not enabled, e.g., with clang --analyze. + fix typo in man/default_colors.3x (patch by Tim van der Molen). + update ncurses/llib-lncurses*
2011-01-09 09:17:12 +08:00
* @Id: curs_termattrs.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
ncurses 5.3
2002-10-13 11:35:53 +08:00
-->
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
ncurses 5.1
2000-07-09 10:46:08 +08:00
<HTML>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<HEAD>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
ncurses 5.3
2002-10-13 11:35:53 +08:00
<TITLE>curs_termattrs 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
ncurses 5.1
2000-07-09 10:46:08 +08:00
<BODY>
ncurses 5.9 - patch 20150516 + amend change to ".pc" files to only use the extra loader flags which may have rpath options (report by Sven Joachim, cf: 20150502). + change versioning for dpkg's in test-packages for Ada95 and ncurses-examples for consistency with Debian, to work with package updates. + regenerate html manpages. + clarify handling of carriage return in waddch manual page; it was discussed only in the portability section (prompted by comment on Stack Overflow forum):
2015-05-17 05:01:22 +08:00
<H1 class="no-header">curs_termattrs 3x</H1>
ncurses 5.1
2000-07-09 10:46:08 +08:00
<PRE>
ncurses 5.5
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
ncurses 5.4
2004-02-09 10:15:26 +08:00
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-NAME">NAME</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>,
<STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -
<STRONG>curses</STRONG> environment query routines
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>
<STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG>
<STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
<STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG>
<STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG>
<STRONG>char</STRONG> <STRONG>killchar(void);</STRONG>
<STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
<STRONG>char</STRONG> <STRONG>*longname(void);</STRONG>
<STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
<STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
<STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>baudrate</STRONG> routine returns the output speed of the ter-
minal. The number returned is in bits per second, for
example <STRONG>9600</STRONG>, and is an integer.
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>erasechar</STRONG> routine returns the user's current erase
ncurses 5.1
2000-07-09 10:46:08 +08:00
character.
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>erasewchar</STRONG> routine stores the current erase character
in the location referenced by <EM>ch</EM>. If no erase character
has been defined, the routine fails and the location ref-
erenced by <EM>ch</EM> is not changed.
The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and
ncurses 5.1
2000-07-09 10:46:08 +08:00
delete- character capabilities.
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and
ncurses 5.1
2000-07-09 10:46:08 +08:00
delete-line capabilities, or can simulate them using
scrolling regions. This might be used to determine if it
would be appropriate to turn on physical scrolling using
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>scrollok</STRONG>.
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>killchar</STRONG> routine returns the user's current line kill
ncurses 5.1
2000-07-09 10:46:08 +08:00
character.
ncurses 5.3
2002-10-13 11:35:53 +08:00
The <STRONG>killwchar</STRONG> routine stores the current line-kill charac-
ter in the location referenced by <EM>ch</EM>. If no line-kill
character has been defined, the routine fails and the
location referenced by <EM>ch</EM> is not changed.
The <STRONG>longname</STRONG> routine returns a pointer to a static area
containing a verbose description of the current terminal.
ncurses 5.1
2000-07-09 10:46:08 +08:00
The maximum length of a verbose description is 128 charac-
ncurses 5.3
2002-10-13 11:35:53 +08:00
ters. It is defined only after the call to <STRONG>initscr</STRONG> or
<STRONG>newterm</STRONG>. The area is overwritten by each call to <STRONG>newterm</STRONG>
and is not restored by <STRONG>set_term</STRONG>, so the value should be
saved between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be
ncurses 5.1
2000-07-09 10:46:08 +08:00
used with multiple terminals.
ncurses 5.6 - patch 20080621 + regenerated html documentation. + expand manpage description of parameters for form_driver() and menu_driver() (prompted by discussion with Adam Spragg). + add null-pointer checks for cur_term in baudrate() and def_shell_mode(), def_prog_mode() + fix some memory leaks in delscreen() and wide acs.
2008-06-22 08:16:39 +08:00
If a given terminal does not support a video attribute
that an application program is trying to use, <STRONG>curses</STRONG> may
ncurses 5.9 - patch 20130309 + amend change to toe.c for reading from /dev/zero, to ensure that there is a buffer for the temporary filename (cf: 20120324). + regenerated html manpages. + fix typo in terminfo.head (report by Sven Joachim, cf: 20130302). + updated some autoconf macros: + CF_ACVERSION_CHECK, from byacc 1.9 20130304 + CF_INTEL_COMPILER, CF_XOPEN_SOURCE from luit 2.0-20130217 + add configure option --with-cxx-shared to permit building libncurses++ as a shared library when using g++, e.g., the same limitations as libtool but better integrated with the usual build configuration (Redhat 911540). + modify MKkey_defs.sh to filter out build-path which was unnecessarily shown in curses.h (Debian #689131).
2013-03-10 08:35:23 +08:00
substitute a different video attribute for it. The <STRONG>ter-</STRONG>
<STRONG>mattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return a logical <STRONG>OR</STRONG> of all
video attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> and
<EM>WA</EM><STRONG>_</STRONG> constants respectively. This information is useful
when a <STRONG>curses</STRONG> program needs complete control over the
ncurses 5.6 - patch 20080621 + regenerated html documentation. + expand manpage description of parameters for form_driver() and menu_driver() (prompted by discussion with Adam Spragg). + add null-pointer checks for cur_term in baudrate() and def_shell_mode(), def_prog_mode() + fix some memory leaks in delscreen() and wide acs.
2008-06-22 08:16:39 +08:00
appearance of the screen.
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.4
2004-02-09 10:15:26 +08:00
The <STRONG>termname</STRONG> routine returns the terminal name used by
<STRONG>setupterm</STRONG>.
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.3
2002-10-13 11:35:53 +08:00
Routines that return an integer return <STRONG>ERR</STRONG> upon failure
and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
<STRONG>ERR</STRONG>") upon successful completion.
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
Note that <STRONG>termattrs</STRONG> may be a macro.
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
The XSI Curses standard, Issue 4 describes these func-
tions. It changes the return type of <STRONG>termattrs</STRONG> to the new
ncurses 5.4
2004-02-09 10:15:26 +08:00
type <STRONG>attr_t</STRONG>. Most versions of curses truncate the result
returned by <STRONG>termname</STRONG> to 14 characters.
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
ncurses 5.3
2002-10-13 11:35:53 +08:00
<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>
ncurses 5.1
2000-07-09 10:46:08 +08:00
ncurses 5.5
2005-10-10 02:41:57 +08:00
<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
ncurses 5.1
2000-07-09 10:46:08 +08:00
</PRE>
ncurses 5.9 - patch 20150214 + regenerate html manpages using improved man2html from work on xterm. + regenerated ".map" and ".sym" files using improved script, accounting for the "--enable-weak-symbols" configure option (report by Werner Fink).
2015-02-15 09:42:27 +08:00
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
ncurses 5.1
2000-07-09 10:46:08 +08:00
</BODY>
</HTML>
Reference in New Issue Copy Permalink