curs_addch(S)

curs_addch: addch, waddch, mvaddch, mvwaddch, echochar, wechochar -- add a character (with attributes) to a curses window and advance cursor

Syntax

cc ... -lcurses

#include <curses.h>

int addch(chtype ch);
int waddch(WINDOW *win, chtype ch);
int mvaddch(int y, int x, chtype ch);
int mvwaddch(WINDOW *win, int y, int x, chtype ch);
int echochar(chtype ch);
int wechochar(WINDOW *win, chtype ch);

Description

The addch(S), waddch(S), mvaddch(S), and mvwaddch(S) routines put the character ch into the window at the current cursor position of the window and advance the position of the window cursor. Their function is like that of putchar(S). At the right margin, an automatic newline is done. At the bottom of the scrolling region, if scrollok(S) 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(S) 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(S) 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 ORing 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(S) and addch( ).) (see standout(S), predefined video attribute constants, on the curs_attr(S) page).

The echochar(S) and wechochar(S) routines are functionally equivalent to a call to addch( ) followed by a call to refresh(S), or a call to waddch( ) followed by a call to wrefresh(S). 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 A_ALTCHARSET bit is turned on (see curs_attr(S)). Otherwise, the default character listed below is stored in the variable. The names chosen are consistent with VT100 nomenclature.

Name Default Glyph Description

ACS_ULCORNER + upper left-hand corner

ACS_LLCORNER + lower left-hand corner

ACS_URCORNER + upper right-hand corner

ACS_LRCORNER + lower right-hand corner

ACS_RTEE + right tee

ACS_LTEE + left tee

ACS_BTEE + bottom tee

ACS_TTEE + top tee

ACS_HLINE - horizontal line

ACS_VLINE | vertical line

ACS_PLUS + plus

ACS_S1 - scan line 1

ACS_S9 _ scan line 9

ACS_DIAMOND + diamond

ACS_CKBOARD : checker board (stipple)

ACS_DEGREE ' degree symbol

ACS_PLMINUS # plus/minus

ACS_BULLET o bullet

ACS_LARROW < arrow pointing left

ACS_RARROW > arrow pointing right

ACS_DARROW v arrow pointing down

ACS_UARROW [^] arrow pointing up

ACS_BOARD # board of squares

ACS_LANTERN # lantern symbol

ACS_BLOCK # solid square block

Name	Default	Glyph Description
ACS_ULCORNER	+	upper left-hand corner
ACS_LLCORNER	+	lower left-hand corner
ACS_URCORNER	+	upper right-hand corner
ACS_LRCORNER	+	lower right-hand corner
ACS_RTEE	+	right tee
ACS_LTEE	+	left tee
ACS_BTEE	+	bottom tee
ACS_TTEE	+	top tee
ACS_HLINE	-	horizontal line
ACS_VLINE	\|	vertical line
ACS_PLUS	+	plus
ACS_S1	-	scan line 1
ACS_S9	_	scan line 9
ACS_DIAMOND	+	diamond
ACS_CKBOARD	:	checker board (stipple)
ACS_DEGREE	'	degree symbol
ACS_PLMINUS	#	plus/minus
ACS_BULLET	o	bullet
ACS_LARROW	<	arrow pointing left
ACS_RARROW	>	arrow pointing right
ACS_DARROW	v	arrow pointing down
ACS_UARROW	[^]	arrow pointing up
ACS_BOARD	#	board of squares
ACS_LANTERN	#	lantern symbol
ACS_BLOCK	#	solid square block

Return values

All routines return the integer ERR on failure and an integer value other than ERR on successful completion, unless otherwise noted in the preceding routine descriptions.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: addch( ), mvaddch( ), mvwaddch( ), and echochar( ).

Files

/usr/lib/libcurses.a: the library

Standards conformance

addch(S), waddch(S), mvaddch(S), mvwaddch(S), echochar(S), and wechochar(S) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.