diff options
Diffstat (limited to 'upstream/fedora-rawhide/man3/curs_in_wch.3x')
| -rw-r--r-- | upstream/fedora-rawhide/man3/curs_in_wch.3x | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/upstream/fedora-rawhide/man3/curs_in_wch.3x b/upstream/fedora-rawhide/man3/curs_in_wch.3x new file mode 100644 index 00000000..d7af7b58 --- /dev/null +++ b/upstream/fedora-rawhide/man3/curs_in_wch.3x @@ -0,0 +1,81 @@ +.\"*************************************************************************** +.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2002-2010,2017 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: curs_in_wch.3x,v 1.24 2023/11/18 18:00:11 tom Exp $ +.TH curs_in_wch 3X 2023-11-18 "ncurses 6.4" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +.SH NAME +\fB\%in_wch\fP, +\fB\%mvin_wch\fP, +\fB\%mvwin_wch\fP, +\fB\%win_wch\fP \- +get a \fIcurses\fR complex character from a window +.SH SYNOPSIS +.nf +\fB#include <curses.h> +.PP +\fBint in_wch(cchar_t *\fIwcval\fP); +\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwcval\fP); +.PP +\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP); +\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP); +.fi +.SH DESCRIPTION +These functions extract the complex character and rendition from +the current position in the named window into the \fBcchar_t\fP object +referenced by wcval. +.SH RETURN VALUE +No errors are defined in the XSI Curses standard. +This implementation checks for null pointers, returns \fBERR\fP in that case. +Also, the \fImv\fP routines check for error moving the cursor, +returning \fBERR\fP in that case. +Otherwise they return \fBOK\fP. +.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 NOTES +Note that all of these routines may be macros. +.SH PORTABILITY +These functions are described in the XSI Curses standard, Issue 4. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_inch\fP(3X), +\fB\%curs_inchstr\fP(3X), +\fB\%curs_instr\fP(3X), +\fB\%curs_inwstr\fP(3X) |