'\" t.\"***************************************************************************.\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *.\"                                                                          *.\" 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.                                                           *.\"***************************************************************************.\".\" $Id: curs_addch.3x,v 1.23 2004/01/31 13:16:21 tom Exp $.TH curs_addch 3X "".SH NAME\fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR,\fBechochar\fR,\fBwechochar\fR - add a character (with attributes) to a \fBcurses\fR window, then advance the cursor.SH SYNOPSIS\fB#include <curses.h>\fR.PP\fBint addch(const chtype ch);\fR.br\fBint waddch(WINDOW *win, const chtype ch);\fR.br\fBint mvaddch(int y, int x, const chtype ch);\fR.br\fBint mvwaddch(WINDOW *win, int y, int x, const chtype ch);\fR.br\fBint echochar(const chtype ch);\fR.br\fBint wechochar(WINDOW *win, const chtype ch);\fR.br.SH DESCRIPTIONThe \fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR and \fBmvwaddch\fR routines putthe character \fIch\fR into the given window at its current window position,which is then advanced.  They are analogous to \fBputchar\fR in \fBstdio\fR(3).If the advance is at the right margin, the cursor automatically wraps to thebeginning of the next line.  At the bottom of the current scrolling region, if\fBscrollok\fR is enabled, the scrolling region is scrolled up one line..PPIf \fIch\fR is a tab, newline, or backspace,the cursor is moved appropriately within the window.Backspace moves the cursor one character left; at the leftedge of a window it does nothing.Newline does a \fBclrtoeol\fR,then moves the cursor to the window left margin on the next line,scrolling the window if on the last line.Tabs are considered to be at every eighth column.The tab interval may be altered by setting the \fBTABSIZE\fR variable..PPIf \fIch\fR is any control character other than tab, newline, or backspace, itis drawn in \fB^\fR\fIX\fR notation.  Calling \fBwinch\fR after adding acontrol character does not return the character itself, but instead returnsthe ^-representation of the control character..PPVideo attributes can be combined with a character argument passed to\fBaddch\fR or related functions by logical-ORing them into the character.(Thus, text, including attributes, can be copied from one place to anotherusing \fBinch\fR and \fBaddch\fR.)  See the \fBcurs_attr\fR(3X) page forvalues of predefined video attribute constants that can be usefully OR'edinto characters..PPThe \fBechochar\fR and \fBwechochar\fR routines are equivalent to a call to\fBaddch\fR followed by a call to \fBrefresh\fR, or a call to \fBwaddch\fRfollowed by a call to \fBwrefresh\fR.  The knowledge that only a singlecharacter is being output is used and, for non-control characters, aconsiderable performance gain may be seen by using these routines instead oftheir equivalents..SS Line GraphicsThe following variables may be used to add line drawing characters to thescreen with routines of the \fBaddch\fR family.  The default character listedbelow is used if the \fBacsc\fR capability doesn't define a terminal-specificreplacement for it (but see the EXTENSIONS section below).  The names aretaken from VT100 nomenclature..PP.TSl l l_ _ _l l l.\fIName\fR	\fIDefault\fR	\fIDescription\fRACS_BLOCK	#	solid square blockACS_BOARD	#	board of squaresACS_BTEE	+	bottom teeACS_BULLET	o	bulletACS_CKBOARD	:	checker board (stipple)ACS_DARROW	v	arrow pointing downACS_DEGREE	'	degree symbolACS_DIAMOND	+	diamondACS_GEQUAL	>	greater-than-or-equal-toACS_HLINE	-	horizontal lineACS_LANTERN	#	lantern symbolACS_LARROW	<	arrow pointing leftACS_LEQUAL	<	less-than-or-equal-toACS_LLCORNER	+	lower left-hand cornerACS_LRCORNER	+	lower right-hand cornerACS_LTEE	+	left teeACS_NEQUAL	!	not-equalACS_PI	*	greek piACS_PLMINUS	#	plus/minusACS_PLUS	+	plusACS_RARROW	>	arrow pointing rightACS_RTEE	+	right teeACS_S1	-	scan line 1ACS_S3	-	scan line 3ACS_S7	-	scan line 7ACS_S9	\&_	scan line 9ACS_STERLING	f	pound-sterling symbolACS_TTEE	+	top teeACS_UARROW	^	arrow pointing upACS_ULCORNER	+	upper left-hand cornerACS_URCORNER	+	upper right-hand cornerACS_VLINE	|	vertical line.TE.SH RETURN VALUEAll routines return the integer \fBERR\fR upon failure and \fBOK\fR on success(the SVr4 manuals specify only "an integer value other than \fBERR\fR") uponsuccessful completion, unless otherwise noted in the preceding routinedescriptions..SH NOTESNote that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and\fBechochar\fR may be macros..SH PORTABILITYAll these functions are described in the XSI Curses standard, Issue 4.The defaults specified for forms-drawing characters apply in the POSIX locale..LPSome ACS symbols(ACS_S3,ACS_S7,ACS_LEQUAL,ACS_GEQUAL,ACS_PI,ACS_NEQUAL,ACS_STERLING)were not documented inany publicly released System V.  However, many publicly available terminfosinclude \fBacsc\fR strings in which their key characters (pryz{|}) areembedded, and a second-hand list of their character descriptions has cometo light.  The ACS-prefixed names for them were invented for \fBncurses\fR(3X)..LPThe \fBTABSIZE\fR variable is implemented in some versions of curses,but is not part of X/Open curses..LPIf \fIch\fR is a carriage return,the cursor is moved to the beginning of the current row of the window.This is true of other implementations, but is not documented..SH SEE ALSO\fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_clear\fR(3X),\fBcurs_inch\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X),\fBputc\fR(3S)..\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: