diff options
Diffstat (limited to 'man/curs_add_wchstr.3x')
| -rw-r--r-- | man/curs_add_wchstr.3x | 64 |
1 files changed, 43 insertions, 21 deletions
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x index 957adc0..37e3df6 100644 --- a/man/curs_add_wchstr.3x +++ b/man/curs_add_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2010 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2010,2012 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 * @@ -26,8 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wchstr.3x,v 1.9 2010/12/04 18:36:44 tom Exp $ +.\" $Id: curs_add_wchstr.3x,v 1.10 2012/11/03 22:54:43 tom Exp $ .TH curs_add_wchstr 3X "" +.de bP +.IP \(bu 4 +.. +.na +.hy 0 .SH NAME \fBadd_wchstr\fR, \fBadd_wchnstr\fR, @@ -37,10 +42,12 @@ \fBmvadd_wchnstr\fR, \fBmvwadd_wchstr\fR, \fBmvwadd_wchnstr\fR \- add an array of complex characters (and attributes) to a curses window +.ad +.hy .SH SYNOPSIS -.B #include <curses.h> -.PP .nf +\fB#include <curses.h>\fR +.PP \fBint add_wchstr(const cchar_t *\fR\fIwchstr\fR\fB);\fR .br \fBint add_wchnstr(const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR @@ -58,38 +65,53 @@ \fBint mvwadd_wchnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR .fi .SH DESCRIPTION -These routines copy the array of complex characters \fIwchstr\fR -into the window image structure at and after the current cursor position. -The four routines with \fIn\fR as the last -argument copy at most \fIn\fR elements, but no more than will fit on the line. +These functions copy the (null-terminated) +array of complex characters \fIwchstr\fR +into the window image structure +starting at the current cursor position. +The four functions with \fIn\fR as the last +argument copy at most \fIn\fR elements, +but no more than will fit on the line. If \fBn\fR=\fB\-1\fR then the whole array is copied, to the maximum number of characters that will fit on the line. .PP The window cursor is \fInot\fR advanced. -These routines work faster than \fBwaddnstr\fR. -On the other hand, they do not perform checking +These functions work faster than \fBwaddnstr\fR. +On the other hand: +.bP +they do not perform checking (such as for the newline, backspace, or carriage return characters), +.bP they do not advance the current cursor position, -they do not expand other control characters to ^-escapes, -and they truncate the string if it crosses the right margin, +.bP +they do not expand other control characters to ^-escapes, and +.bP +they truncate the string if it crosses the right margin, rather than wrapping it around to the new line. .PP -These routines end successfully +These functions end successfully on encountering a null \fIcchar_t\fR, or when they have filled the current line. If a complex character cannot completely fit at the end of the current line, the remaining columns are filled with the background character and rendition. -.SH NOTES -All functions except \fBwadd_wchnstr\fR may be macros. -.SH RETURN VALUES -All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success. +.SH RETURN VALUE +All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success. +.PP +X/Open does not define any error conditions. +This implementation returns an error +if the window pointer is null. .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 +All functions except \fBwadd_wchnstr\fR may be macros. .SH PORTABILITY -All these entry points are described in the XSI Curses standard, Issue 4. +These entry points are described in the XSI Curses standard, Issue 4. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_addchstr\fR(3X), -\fBcurs_addwstr\fR(3X) +\fBcurs_addwstr\fR(3X), +\fBcurses\fR(3X). +.PP +Comparable functions in the narrow-character (ncurses) library are +described in +\fBcurs_addchstr\fR(3X). |