curs_addch(3X) curs_addch(3X)
NAME
cursaddch: addch, waddch, mvaddch, mvwaddch, echochar, wechochar -
add a character (with attributes) to a curses window and advance
cursor
SYNOPSIS
#include <curses.h>
addch(chtype ch);
waddch(WINDOW *win, chtype ch);
mvaddch(int y, int x, chtype ch);
mvwaddch(WINDOW *win, int y, int x, chtype ch);
echochar(chtype ch);
wechochar(WINDOW *win, chtype ch);
DESCRIPTION
With the addch, waddch, mvaddch and mvwaddch routines, the character
ch is put into the window at the current cursor position of the
window and the position of the window cursor is advanced. Its
function is similar to that of putchar. At the right margin, an
automatic newline is performed. At the bottom of the scrolling
region, if scrollok is enabled, the scrolling region is scrolled up
one line.
If ch is a tab, newline, or backspace, the cursor is moved
appropriately within the window. A newline also does a clrtoeol
before moving. Tabs are considered to be at every eighth column. If
ch is another control character, it is drawn in the ^X notation.
Calling winch after adding a control character does not return the
control character, but instead returns the representation of the
control character.
Video attributes can be combined with a character by OR-ing them into
the parameter. This results in these attributes also being set.
(The intent here is that text, including attributes, can be copied
from one place to another using inch and addch.) [see standout,
predefined video attribute constants, on the curs_attr(3X) page].
The echochar and wechochar routines are functionally equivalent to a
call to addch followed by a call to refresh, or a call to waddch
followed by a call to wrefresh. The knowledge that only a single
character is being output is taken into consideration and, for non-
control characters, a considerable performance gain might be seen by
using these routines instead of their equivalents.
Line Graphics
The following variables may be used to add line drawing characters to
the screen with routines of the addch family. When variables are
defined for the terminal, the AALTCHARSET bit is turned on [see
curs_attr(3X)]. Otherwise, the default character listed below is
stored in the variable. The names chosen are consistent with the
8/91 Page 1
curs_addch(3X) curs_addch(3X)
VT100 nomenclature.
__________________________________________________
Name Default Glyph Description
__________________________________________________
ACSULCORNER + upper left-hand corner
ACSLLCORNER + lower left-hand corner
ACSURCORNER + upper right-hand corner
ACSLRCORNER + lower right-hand corner
ACSRTEE + right tee (-|)
ACSLTEE + left tee (†)
ACSBTEE + bottom tee (|)
|) ACSTTEE + top tee (
ACSHLINE - horizontal line
ACSVLINE | vertical line
ACSPLUS + plus
ACSS1 - scan line 1
ACSS9 _ scan line 9
ACSDIAMOND + diamond
ACSCKBOARD : checker board (stipple)
ACSDEGREE ' degree symbol
ACSPLMINUS # plus/minus
ACSBULLET o bullet
ACSLARROW < arrow pointing left
ACSRARROW > arrow pointing right
ACSDARROW v arrow pointing down
ACSUARROW ^ arrow pointing up
ACSBOARD # board of squares
ACSLANTERN # lantern symbol
ACSBLOCK # solid square block
__________________________________________________
RETURN VALUE
All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion, unless otherwise noted in
the preceding routine descriptions.
NOTES
The header file <curses.h> automatically includes the header files
<stdio.h> and <unctrl.h>.
Note that addch, mvaddch, mvwaddch, and echochar may be macros.
SEE ALSO
curses(3X), cursattr(3X), cursclear(3X), cursinch(3X),
cursoutopts(3X), cursrefresh(3X) putc(3S).
Page 2 8/91