| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | .\"*************************************************************************** |
| 2 | .\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * |
| 3 | .\" * |
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 5 | .\" copy of this software and associated documentation files (the * |
| 6 | .\" "Software"), to deal in the Software without restriction, including * |
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 9 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 10 | .\" furnished to do so, subject to the following conditions: * |
| 11 | .\" * |
| 12 | .\" The above copyright notice and this permission notice shall be included * |
| 13 | .\" in all copies or substantial portions of the Software. * |
| 14 | .\" * |
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 22 | .\" * |
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 24 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 25 | .\" sale, use or other dealings in this Software without prior written * |
| 26 | .\" authorization. * |
| 27 | .\"*************************************************************************** |
| 28 | .\" |
| 29 | .\" $Id: curs_addwstr.3x,v 1.7 2006/02/25 20:59:08 tom Exp $ |
| 30 | .TH curs_addwstr 3X "" |
| 31 | .na |
| 32 | .hy 0 |
| 33 | .SH NAME |
| 34 | \fBaddwstr\fR, |
| 35 | \fBaddnwstr\fR, |
| 36 | \fBwaddwstr\fR, |
| 37 | \fBwaddnwstr\fR, |
| 38 | \fBmvaddwstr\fR, |
| 39 | \fBmvaddnwstr\fR, |
| 40 | \fBmvwaddwstr\fR, |
| 41 | \fBmvwaddnwstr\fR \- add a string of wide characters to a \fBcurses\fR window and advance cursor |
| 42 | .ad |
| 43 | .hy |
| 44 | .SH SYNOPSIS |
| 45 | .nf |
| 46 | \fB#include <curses.h>\fR |
| 47 | .PP |
| 48 | \fBint addwstr(const wchar_t *\fR\fIwstr\fR\fB);\fR |
| 49 | .br |
| 50 | \fBint addnwstr(const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR |
| 51 | .br |
| 52 | \fBint waddwstr(WINDOW *\fR\fIwin\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR |
| 53 | .br |
| 54 | \fBint waddnwstr(WINDOW *\fR\fIwin\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR |
| 55 | .br |
| 56 | \fBint mvaddwstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR |
| 57 | .br |
| 58 | \fBint mvaddnwstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR |
| 59 | .br |
| 60 | \fBint mvwaddwstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR |
| 61 | .br |
| 62 | \fBint mvwaddnwstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR |
| 63 | .fi |
| 64 | .SH DESCRIPTION |
| 65 | These routines write the characters of the |
| 66 | (null-terminated) \fBwchar_t\fR character string |
| 67 | \fIwstr\fR on the given window. |
| 68 | It is similar to constructing a \fBcchar_t\fR for each wchar_t in the string, |
| 69 | then calling \fBwadd_wch\fR for the resulting \fBcchar_t\fR. |
| 70 | .PP |
| 71 | The \fImv\fR routines perform cursor movement once, before writing any |
| 72 | characters. |
| 73 | Thereafter, the cursor is advanced as a side-effect of writing to the window. |
| 74 | .PP |
| 75 | The four routines with \fIn\fR as the last argument |
| 76 | write at most \fIn\fR \fBwchar_t\fR characters. |
| 77 | If \fIn\fR is -1, then the entire string will be added, |
| 78 | up to the maximum number of characters that will fit on the line, |
| 79 | or until a terminating null is reached. |
| 80 | .SH RETURN VALUES |
| 81 | All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success. |
| 82 | .SH NOTES |
| 83 | Note that all of these routines except \fBwaddnwstr\fR may be macros. |
| 84 | .SH PORTABILITY |
| 85 | All these entry points are described in the XSI Curses standard, Issue 4. |
| 86 | .SH SEE ALSO |
| 87 | \fBcurses\fR(3X), |
| 88 | \fBcurs_add_wch\fR(3X) |
| 89 | .\"# |
| 90 | .\"# The following sets edit modes for GNU EMACS |
| 91 | .\"# Local Variables: |
| 92 | .\"# mode:nroff |
| 93 | .\"# fill-column:79 |
| 94 | .\"# End: |