diff options
Diffstat (limited to 'man/curs_inwstr.3x')
| -rw-r--r-- | man/curs_inwstr.3x | 52 |
1 files changed, 33 insertions, 19 deletions
diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x index 0cdf4d8df65b..a2779aca1d3b 100644 --- a/man/curs_inwstr.3x +++ b/man/curs_inwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2018,2019 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,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inwstr.3x,v 1.8 2012/11/03 23:03:59 tom Exp $ +.\" $Id: curs_inwstr.3x,v 1.12 2019/11/30 21:06:30 tom Exp $ .TH curs_inwstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME \fBinwstr\fR, \fBinnwstr\fR, @@ -41,48 +45,58 @@ .nf \fB#include <curses.h> \fR .sp -\fBint inwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB);\fR +\fBint inwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB);\fR .br -\fBint innwstr(\fR\fBwchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint innwstr(\fR\fBwchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR .br -\fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR +\fBint winwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR .br -\fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint winnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR .br -\fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR +\fBint mvinwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR .br -\fBint mvinnwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint mvinnwstr(\fR\fBint \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR .br -\fBint mvwinwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB);\fR +\fBint mvwinwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB);\fR .br -\fBint mvwinnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR +\fBint mvwinnwstr(\fR\fBWINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR .fi .SH DESCRIPTION -These routines return a string of \fBwchar_t\fR characters in \fIwstr\fR, +.PP +These routines return a string of \fBwchar_t\fR wide characters in \fIwstr\fR, extracted starting at the current cursor position in the named window. -Attributes are stripped from the characters. -The four functions with \fIn\fR as the last argument return a leading substring at most -\fIn\fR bytes long (exclusive of the trailing NUL). -Transfer stops at the end of the current line, or when \fIn\fR bytes have +.PP +The four functions with \fIn\fR as the last argument return +a leading substring at most \fIn\fR characters long +(exclusive of the trailing NUL). +Transfer stops at the end of the current line, or when \fIn\fR characters have been stored at the location referenced by \fIwstr\fR. .PP -If the size \fIn\fR is not large enough to store a complete character, +If the size \fIn\fR is not large enough to store a complete complex character, an error is generated. .SH NOTES -Note that all routines except +.PP +All routines except \fBwinnwstr\fR may be macros. +.PP +Each cell in the window holds a complex character (i.e., base- +and combining-characters) together with attributes and color. +These functions store only the wide characters, +ignoring attributes and color. +Use \fBin_wchstr\fP to return the complex characters from a window. .SH RETURN VALUE All routines return \fBERR\fR -upon failure. Upon +upon failure. +Upon successful completion, the *\fBinwstr\fR routines return \fBOK\fR, and the *\fBinnwstr\fR routines return the number of characters read into the string. .PP -Functions with a "mv" prefix first perform a cursor movement using +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 |