X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_add_wchstr.3x;h=d76a9e19c93f44e31166c733590881f2991465b2;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hp=5ce6d04cf3d3b15b4dc3c4429661bd14179b92cf;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x index 5ce6d04c..d76a9e19 100644 --- a/man/curs_add_wchstr.3x +++ b/man/curs_add_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019,2020 Thomas E. Dickey * +.\" Copyright 2019-2020,2021 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wchstr.3x,v 1.13 2020/02/02 23:34:34 tom Exp $ +.\" $Id: curs_add_wchstr.3x,v 1.18 2021/12/25 21:41:58 tom Exp $ .TH curs_add_wchstr 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -40,49 +40,49 @@ .na .hy 0 .SH NAME -\fBadd_wchstr\fR, -\fBadd_wchnstr\fR, -\fBwadd_wchstr\fR, -\fBwadd_wchnstr\fR, -\fBmvadd_wchstr\fR, -\fBmvadd_wchnstr\fR, -\fBmvwadd_wchstr\fR, -\fBmvwadd_wchnstr\fR \- add an array of complex characters (and attributes) to a curses window +\fBadd_wchstr\fP, +\fBadd_wchnstr\fP, +\fBwadd_wchstr\fP, +\fBwadd_wchnstr\fP, +\fBmvadd_wchstr\fP, +\fBmvadd_wchnstr\fP, +\fBmvwadd_wchstr\fP, +\fBmvwadd_wchnstr\fP \- add an array of complex characters (and attributes) to a curses window .ad .hy .SH SYNOPSIS .nf -\fB#include \fR +\fB#include \fP .PP -\fBint add_wchstr(const cchar_t *\fR\fIwchstr\fR\fB);\fR +\fBint add_wchstr(const cchar_t *\fP\fIwchstr\fP\fB);\fP .br -\fBint add_wchnstr(const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint add_wchnstr(const cchar_t *\fP\fIwchstr\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint wadd_wchstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR +\fBint wadd_wchstr(WINDOW *\fP \fIwin\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB);\fP .br -\fBint wadd_wchnstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint wadd_wchnstr(WINDOW *\fP \fIwin\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB, int \fP\fIn\fP\fB);\fP +.sp +\fBint mvadd_wchstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB);\fP .br -\fBint mvadd_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR +\fBint mvadd_wchnstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB, int \fP\fIn\fP\fB);\fP .br -\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 +\fBint mvwadd_wchstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB);\fP .br -\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 -.br -\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 +\fBint mvwadd_wchnstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const cchar_t *\fP\fIwchstr\fP\fB, int \fP\fIn\fP\fB);\fP .fi .SH DESCRIPTION These functions copy the (null-terminated) -array of complex characters \fIwchstr\fR +array of complex characters \fIwchstr\fP 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, +The four functions with \fIn\fP as the last +argument copy at most \fIn\fP elements, but no more than will fit on the line. -If \fBn\fR=\fB\-1\fR then the whole array is copied, +If \fBn\fP=\fB\-1\fP 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 functions work faster than \fBwaddnstr\fR. +The window cursor is \fInot\fP advanced. +These functions work faster than \fBwaddnstr\fP. On the other hand: .bP they do not perform checking @@ -96,12 +96,12 @@ they truncate the string if it crosses the right margin, rather than wrapping it around to the new line. .PP These functions end successfully -on encountering a null \fIcchar_t\fR, or +on encountering a null \fBcchar_t\fP, 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 RETURN VALUE -All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success. +All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. .PP X/Open does not define any error conditions. This implementation returns an error @@ -111,13 +111,13 @@ 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. +All functions except \fBwadd_wchnstr\fP may be macros. .SH PORTABILITY These entry points are described in the XSI Curses standard, Issue 4. .SH SEE ALSO -\fBcurs_addwstr\fR(3X), -\fBcurses\fR(3X). +\fBcurses\fP(3X), +\fBcurs_addwstr\fP(3X). .PP Comparable functions in the narrow-character (ncurses) library are described in -\fBcurs_addchstr\fR(3X). +\fBcurs_addchstr\fP(3X).