| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 2002-2005,2010 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_add_wchstr.3x,v 1.9 2010/12/04 18:36:44 tom Exp $
|
|---|
| 30 | .TH curs_add_wchstr 3X ""
|
|---|
| 31 | .SH NAME
|
|---|
| 32 | \fBadd_wchstr\fR,
|
|---|
| 33 | \fBadd_wchnstr\fR,
|
|---|
| 34 | \fBwadd_wchstr\fR,
|
|---|
| 35 | \fBwadd_wchnstr\fR,
|
|---|
| 36 | \fBmvadd_wchstr\fR,
|
|---|
| 37 | \fBmvadd_wchnstr\fR,
|
|---|
| 38 | \fBmvwadd_wchstr\fR,
|
|---|
| 39 | \fBmvwadd_wchnstr\fR \- add an array of complex characters (and attributes) to a curses window
|
|---|
| 40 | .SH SYNOPSIS
|
|---|
| 41 | .B #include <curses.h>
|
|---|
| 42 | .PP
|
|---|
| 43 | .nf
|
|---|
| 44 | \fBint add_wchstr(const cchar_t *\fR\fIwchstr\fR\fB);\fR
|
|---|
| 45 | .br
|
|---|
| 46 | \fBint add_wchnstr(const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 47 | .br
|
|---|
| 48 | \fBint wadd_wchstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
|
|---|
| 49 | .br
|
|---|
| 50 | \fBint wadd_wchnstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 51 | .br
|
|---|
| 52 | \fBint mvadd_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
|
|---|
| 53 | .br
|
|---|
| 54 | \fBint mvadd_wchnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|---|
| 55 | .br
|
|---|
| 56 | \fBint mvwadd_wchstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
|
|---|
| 57 | .br
|
|---|
| 58 | \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
|
|---|
| 59 | .fi
|
|---|
| 60 | .SH DESCRIPTION
|
|---|
| 61 | These routines copy the array of complex characters \fIwchstr\fR
|
|---|
| 62 | into the window image structure at and after the current cursor position.
|
|---|
| 63 | The four routines with \fIn\fR as the last
|
|---|
| 64 | argument copy at most \fIn\fR elements, but no more than will fit on the line.
|
|---|
| 65 | If \fBn\fR=\fB\-1\fR then the whole array is copied,
|
|---|
| 66 | to the maximum number of characters that will fit on the line.
|
|---|
| 67 | .PP
|
|---|
| 68 | The window cursor is \fInot\fR advanced.
|
|---|
| 69 | These routines work faster than \fBwaddnstr\fR.
|
|---|
| 70 | On the other hand, they do not perform checking
|
|---|
| 71 | (such as for the newline, backspace, or carriage return characters),
|
|---|
| 72 | they do not advance the current cursor position,
|
|---|
| 73 | they do not expand other control characters to ^-escapes,
|
|---|
| 74 | and they truncate the string if it crosses the right margin,
|
|---|
| 75 | rather than wrapping it around to the new line.
|
|---|
| 76 | .PP
|
|---|
| 77 | These routines end successfully
|
|---|
| 78 | on encountering a null \fIcchar_t\fR, or
|
|---|
| 79 | when they have filled the current line.
|
|---|
| 80 | If a complex character cannot completely fit at the end of the current line,
|
|---|
| 81 | the remaining columns are filled with the background character and rendition.
|
|---|
| 82 | .SH NOTES
|
|---|
| 83 | All functions except \fBwadd_wchnstr\fR may be macros.
|
|---|
| 84 | .SH RETURN VALUES
|
|---|
| 85 | All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success.
|
|---|
| 86 | .PP
|
|---|
| 87 | Functions with a "mv" prefix first perform a cursor movement using
|
|---|
| 88 | \fBwmove\fP, and return an error if the position is outside the window,
|
|---|
| 89 | or if the window pointer is null.
|
|---|
| 90 | .SH PORTABILITY
|
|---|
| 91 | All these entry points are described in the XSI Curses standard, Issue 4.
|
|---|
| 92 | .SH SEE ALSO
|
|---|
| 93 | \fBcurses\fR(3X),
|
|---|
| 94 | \fBcurs_addchstr\fR(3X),
|
|---|
| 95 | \fBcurs_addwstr\fR(3X)
|
|---|
