ncurses 5.7 - patch 20100918
[ncurses.git] / man / curs_add_wch.3x
index fae59ae0b6cdeac3142dc6471dbe5e1077c29ab0..8d5d640a4aa9d8eda2e1cfe5071f3512c5c29082 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2001,2002 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 2001-2006,2010 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_add_wch.3x,v 1.4 2002/02/16 22:28:43 tom Exp $
+.\" $Id: curs_add_wch.3x,v 1.9 2010/09/18 20:18:34 tom Exp $
 .TH curs_add_wch 3X ""
+.de bP
+.IP \(bu 4
+..
 .SH NAME
 \fBadd_wch\fP,
 \fBwadd_wch\fP,
 \fBmvadd_wch\fP,
 \fBmvwadd_wch\fP,
 \fBecho_wchar\fP,
-\fBwecho_wchar\fP - add a complex character and rendition to a \fBcurses\fR window, then advance the cursor
+\fBwecho_wchar\fP \- add a complex character and rendition to a \fBcurses\fR window, then advance the cursor
 .SH SYNOPSIS
 .PP
 \fB#include <curses.h>\fP
@@ -63,26 +66,23 @@ window at its current position,
 which is then advanced.
 These functions perform
 wrapping and special-character processing as follows:
-.TP 5
--
+.bP
 If \fIwch\fP refers to a spacing character,
 then any previous character at that location is removed.
 A new character specified by \fIwch\fP is
 placed at that location with rendition specified by \fIwch\fP.
 The cursor then advances to
 the next spacing character on the screen.
-.TP 5
--
+.bP
 If \fIwch\fP refers to a non-spacing character,
 all previous characters at that location are preserved.
 The non-spacing characters of \fIwch\fP
 are added to the spacing complex character,
 and the rendition specified by \fIwch\fP is ignored.
-.TP 5
--
+.bP
 If the character part of \fIwch\fP is
 a tab, newline, backspace or other control character,
-the window is updated and the cursor moves as if \fBaddch\fR(3X) were called.
+the window is updated and the cursor moves as if \fBaddch\fR were called.
 .PP
 The \fBecho_wchar\fP
 function is functionally equivalent to a call to
@@ -102,6 +102,10 @@ by using the *\fBecho\fP* functions instead of their equivalents.
 .SH RETURN VALUES
 .PP
 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success.
+.PP
+Functions with a "mv" prefix first perform a cursor movement using
+\fBwmove\fP, and return an error if the position is outside the window,
+or if the window pointer is null.
 .SH NOTES
 .PP
 Note that
@@ -121,7 +125,8 @@ Those are not currently implemented in \fBncurses\fP.
 .SH SEE ALSO
 .PP
 \fBcurses\fR(3X),
-\fBcurs_attr_get\fR(3X),
+\fBcurs_addch\fR(3X),
+\fBcurs_attr\fR(3X),
 \fBcurs_clear\fR(3X),
 \fBcurs_outopts\fR(3X),
 \fBcurs_refresh\fR(3X),