X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_ins_wstr.3x;h=12479b0d9306593371d521460b0e1bc6039f7500;hp=197f30f5cd7d420a41ae679305ac86fa2d9f1331;hb=6b96eb711cbf58da43002ff14b66d8a52c19a731;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;ds=inline diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x index 197f30f5..12479b0d 100644 --- a/man/curs_ins_wstr.3x +++ b/man/curs_ins_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002 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,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_ins_wstr.3x,v 1.2 2002/03/10 23:43:27 tom Exp $ +.\" $Id: curs_ins_wstr.3x,v 1.7 2012/11/03 23:03:59 tom Exp $ .TH curs_ins_wstr 3X "" +.na +.hy 0 .SH NAME \fBins_wstr\fR, \fBins_nwstr\fR, @@ -37,10 +39,12 @@ \fBmvins_nwstr\fR, \fBmvwins_wstr\fR, \fBmvwins_nwstr\fR \- insert a wide-character string into a curses window +.ad +.hy .SH SYNOPSIS .nf \fB#include \fR - +.sp \fBint ins_wstr(const wchar_t *\fR\fIwstr);\fR .br \fBint ins_nwstr(const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR @@ -69,7 +73,7 @@ The cursor position does not change The four routines with \fIn\fR as the last argument insert a leading substring of at most \fIn\fR \fBwchar_t\fR characters. If \fIn\fR is less than 1, the entire string is inserted. - +.PP If a character in \fIwstr\fR is a tab, newline, carriage return or backspace, the cursor is moved appropriately within the window. A newline also does a \fBclrtoeol\fR before moving. @@ -83,22 +87,20 @@ but instead returns a character in the ^-representation of the control character. .SH NOTES Note that all but wins_nwstr may be macros. - +.PP If the first character in the string is a nonspacing character, these functions will fail. XSI does not define what will happen if a nonspacing character follows a control character. -.SH RETURN VALUES +.SH RETURN VALUE Upon successful completion, these functions return OK. Otherwise, they return ERR. +.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 SEE ALSO \fBcurses\fR(3X), \fBcurs_insstr\fR(3X), \fBcurs_in_wch\fR(3X), \fBcurs_ins_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: