<!--
* t
****************************************************************************
- * Copyright 2018-2022,2023 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_attr.3x,v 1.91 2023/12/02 21:05:24 tom Exp @
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
- * ---------------------------------------------------------------------------
+ * @Id: curs_attr.3x,v 1.99 2024/03/16 15:38:33 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_attr 3x 2023-12-02 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_attr 3x 2024-03-16 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">curs_attr 3x 2023-12-02 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_attr 3x 2024-03-16 ncurses 6.4 Library calls</H1>
<PRE>
<STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
attributes used for erasing and clearing.
-</PRE><H3><a name="h3-Window-
attributes">Window attributes</a></H3><PRE>
+</PRE><H3><a name="h3-Window-
Attributes">Window Attributes</a></H3><PRE>
There are two sets of functions:
<STRONG>o</STRONG> functions for manipulating the window attributes and color:
together in <EM>attr</EM>, without affecting other attributes.
-</PRE><H3><a name="h3-Legacy-
window-attributes">Legacy window attributes</a></H3><PRE>
+</PRE><H3><a name="h3-Legacy-
Window-Attributes">Legacy Window Attributes</a></H3><PRE>
The X/Open window attribute routines which <EM>set</EM> or <EM>get</EM>, turn <EM>on</EM> or <EM>off</EM>
are extensions of older routines which assume that color pairs are OR'd
into the attribute parameter. These newer routines use similar names,
attr_set(A_BOLD, <EM>pair</EM>, NULL);
However, if the value does not fit, then the <STRONG>COLOR_PAIR</STRONG> macro uses only
- the bits that fit. For example, because in ncurses <STRONG>A_COLOR</STRONG> has eight
+ the bits that fit. For example, because in <EM>ncurses</EM> <STRONG>A_COLOR</STRONG> has eight
(8) bits, then <STRONG>COLOR_PAIR(</STRONG><EM>259</EM><STRONG>)</STRONG> is 4 (i.e., 259 is 4 more than the limit
255).
than <STRONG>attr_t</STRONG>.
There is no corresponding <STRONG>attrget</STRONG> function as such in X/Open Curses,
- although
ncurses provides <STRONG>getattrs</STRONG> (see <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>).
+ although
<EM>ncurses</EM> provides <STRONG>getattrs</STRONG> (see <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>).
-</PRE><H3><a name="h3-Change-
character-rendition">Change character rendition</a></H3><PRE>
+</PRE><H3><a name="h3-Change-
Character-Rendition">Change Character Rendition</a></H3><PRE>
The routine <STRONG>chgat</STRONG> changes the attributes of a given number of
characters starting at the current cursor location of <STRONG>stdscr</STRONG>. It does
not update the cursor and does not perform wrapping. A character count
function generalizes this to any window; the <STRONG>mvwchgat</STRONG> function does a
cursor move before acting.
- In these functions, the color <EM>pair</EM> argument is a color-pair index (as
+ In these functions, the color <EM>pair</EM> argument is a color pair index (as
in the first argument of <STRONG>init_pair</STRONG>, see <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>).
-</PRE><H3><a name="h3-Change-
window-color">Change window color</a></H3><PRE>
+</PRE><H3><a name="h3-Change-
Window-Color">Change Window Color</a></H3><PRE>
The routine <STRONG>color_set</STRONG> sets the current color of the given window to the
foreground/background combination described by the color <EM>pair</EM>
parameter.
<STRONG>standend</STRONG> is the same as <STRONG>attrset(A_NORMAL)</STRONG> or <STRONG>attrset(0)</STRONG>, that is, it
turns off all attributes.
- X/Open does not mark these "restricted", because
+ X/Open Curses does not mark these "restricted", because
<STRONG>o</STRONG> they have well established legacy use, and
<STRONG>Name</STRONG> <STRONG>Description</STRONG>
-----------------------------------------------------------------
<STRONG>A_NORMAL</STRONG> Normal display (no highlight)
- <STRONG>A_STANDOUT</STRONG> Best highlighting mode of the terminal.
+ <STRONG>A_STANDOUT</STRONG> Best highlighting mode of the terminal
<STRONG>A_UNDERLINE</STRONG> Underlining
<STRONG>A_REVERSE</STRONG> Reverse video
<STRONG>A_BLINK</STRONG> Blinking
(which also support the attributes recognized by <STRONG>attron</STRONG>, etc.):
<STRONG>Name</STRONG> <STRONG>Description</STRONG>
- -----------------------------------------
+ -----------------------------------------------------------------
<STRONG>WA_HORIZONTAL</STRONG> Horizontal highlight
<STRONG>WA_LEFT</STRONG> Left highlight
<STRONG>WA_LOW</STRONG> Low highlight
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
All routines return the integer <STRONG>OK</STRONG> on success, or <STRONG>ERR</STRONG> on failure.
- X/Open does not define any error conditions.
+ X/Open Curses does not specify any error conditions.
This implementation
outside the range 0..COLOR_PAIRS-1.
<STRONG>o</STRONG> does not return an error if either of the parameters of <STRONG>wattr_get</STRONG>
- used for retrieving attribute or color-pair values is <STRONG>NULL</STRONG>.
+ used for retrieving attribute or color pair values is <STRONG>NULL</STRONG>.
Functions with a "mv" prefix first perform a cursor movement using
<STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
Color pair values can only be OR'd with attributes if the pair number
is less than 256. The alternate functions such as <STRONG>color_set</STRONG> can pass a
- color pair value directly. However, ncurses ABI 4 and 5 simply OR this
- value within the alternate functions. You must use ncurses ABI 6 to
+ color pair value directly. However, <EM>ncurses</EM> ABI 4 and 5 simply OR this
+ value within the alternate functions. You must use <EM>ncurses</EM> ABI 6 to
support more than 256 color pairs.
X/Open Curses still (after more than twenty years) documents as
reserved for future use, saying that it should be <STRONG>NULL</STRONG>. This
implementation uses that parameter in ABI 6 for the functions which
- have a color-pair parameter to support <EM>extended</EM> <EM>color</EM> <EM>pairs</EM>:
+ have a color pair parameter to support <EM>extended</EM> <EM>color</EM> <EM>pairs</EM>:
<STRONG>o</STRONG> For functions which modify the color, e.g., <STRONG>wattr_set</STRONG> and <STRONG>wattr_on</STRONG>,
if <EM>opts</EM> is set it is treated as a pointer to <STRONG>int</STRONG>, and used to set
the newer set of names:
<STRONG>Name</STRONG> <STRONG>Description</STRONG>
- ------------------------------------------------------------
+ -----------------------------------------------------------------
<STRONG>WA_NORMAL</STRONG> Normal display (no highlight)
- <STRONG>WA_STANDOUT</STRONG> Best highlighting mode of the terminal.
+ <STRONG>WA_STANDOUT</STRONG> Best highlighting mode of the terminal
<STRONG>WA_UNDERLINE</STRONG> Underlining
<STRONG>WA_REVERSE</STRONG> Reverse video
<STRONG>WA_BLINK</STRONG> Blinking
the same because it simplifies copying information between <STRONG>chtype</STRONG>
and <STRONG>cchar_t</STRONG> variables.
- <STRONG>o</STRONG> Because ncurses's <STRONG>attr_t</STRONG> can hold a color pair (in the <STRONG>A_COLOR</STRONG>
+ <STRONG>o</STRONG> Because <EM>ncurses</EM>'s <STRONG>attr_t</STRONG> can hold a color pair (in the <STRONG>A_COLOR</STRONG>
field), a call to <STRONG>wattr_on</STRONG>, <STRONG>wattr_off</STRONG>, or <STRONG>wattr_set</STRONG> may alter the
window's color. If the color pair information in the attribute
parameter is zero, no change is made to the window's color.
alternate character set implementation. A 32-bit library can be used
on a 64-bit system, but not necessarily the reverse.
- <STRONG>Year</STRONG> <STRONG>System</STRONG> <STRONG>Arch</STRONG> <STRONG>Color</STRONG> <STRONG>Char</STRONG> <STRONG>Notes</STRONG>
- ----------------------------------------------------------------
- 1992 Solaris 5.2 32 6 17 SVr4 curses
- 1992 HP-UX 9 32 no 8 SVr2 curses
- 1992 AIX 3.2 32 no 23 SVr2 curses
- 1994 OSF/1 r3 32 no 23 SVr2 curses
- 1995 HP-UX 10.00 32 6 16 SVr3 "curses_colr"
- 1995 HP-UX 10.00 32 6 8 SVr4, X/Open curses
- 1995 Solaris 5.4 32/64 7 16 X/Open curses
- 1996 AIX 4.2 32 7 16 X/Open curses
- 1996 OSF/1 r4 32 6 16 X/Open curses
- 1997 HP-UX 11.00 32 6 8 X/Open curses
- 2000 U/Win 32/64 7/31 16 uses <STRONG>chtype</STRONG>
+ <STRONG>Bits</STRONG>
+ <STRONG>Year</STRONG> <STRONG>System</STRONG> <STRONG>Arch</STRONG> <STRONG>Color</STRONG> <STRONG>Char</STRONG> <STRONG>Notes</STRONG>
+ ------------------------------------------------------------------------
+ 1992 Solaris 5.2 32 6 17 SVr4 <EM>curses</EM>
+ 1992 HP-UX 9 32 no 8 SVr2 <EM>curses</EM>
+ 1992 AIX 3.2 32 no 23 SVr2 <EM>curses</EM>
+ 1994 OSF/1 r3 32 no 23 SVr2 <EM>curses</EM>
+ 1995 HP-UX 10.00 32 6 16 SVr3 <EM>curses</EM><STRONG>_</STRONG><EM>colr</EM>
+ 1995 HP-UX 10.00 32 6 8 SVr4, X/Open <EM>curses</EM>
+ 1995 Solaris 5.4 32/64 7 16 X/Open <EM>curses</EM>
+ 1996 AIX 4.2 32 7 16 X/Open <EM>curses</EM>
+ 1996 OSF/1 r4 32 6 16 X/Open <EM>curses</EM>
+ 1997 HP-UX 11.00 32 6 8 X/Open <EM>curses</EM>
+ 2000 U/Win 32/64 7/31 16 uses <EM>chtype</EM>
Notes:
Regarding OSF/1 (and Tru64),
- <STRONG>o</STRONG> These used 64-bit hardware. Like ncurses, the OSF/1 curses
+ <STRONG>o</STRONG> These used 64-bit hardware. Like <EM>ncurses</EM>, the OSF/1 curses
interface is not customized for 32-bit and 64-bit versions.
<STRONG>o</STRONG> Unlike other systems which evolved from AT&T code, OSF/1
modification to make the library 8-bit clean for <STRONG>nvi(1)</STRONG>. He moved
<EM>standout</EM> attribute to a structure member.
- The resulting 4.4BSD curses was replaced by ncurses over the next
+ The resulting 4.4BSD curses was replaced by <EM>ncurses</EM> over the next
ten years.
<STRONG>o</STRONG> U/Win is rarely used now.
-ncurses 6.4 202
3-12-02 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
+ncurses 6.4 202
4-03-16 <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
<ul>
-<li><a href="#h3-Window-attributes">Window attributes</a></li>
-<li><a href="#h3-Legacy-window-attributes">Legacy window attributes</a></li>
-<li><a href="#h3-Change-character-rendition">Change character rendition</a></li>
-<li><a href="#h3-Change-window-color">Change window color</a></li>
+<li><a href="#h3-Window-Attributes">Window Attributes</a></li>
+<li><a href="#h3-Legacy-Window-Attributes">Legacy Window Attributes</a></li>
+<li><a href="#h3-Change-Character-Rendition">Change Character Rendition</a></li>
+<li><a href="#h3-Change-Window-Color">Change Window Color</a></li>
<li><a href="#h3-Standout">Standout</a></li>
<li><a href="#h3-Video-Attributes">Video Attributes</a></li>
</ul>
projects / ncurses.git / blobdiff