mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-15 21:05:08 +00:00
85 lines
3.7 KiB
Plaintext
85 lines
3.7 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright 2018-2023,2024 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.31 2024/04/20 21:20:07 tom Exp $
|
|
.TH curs_in_wch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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 *\fIwch\fP);
|
|
\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP);
|
|
.PP
|
|
\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\fP);
|
|
\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwch\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 wch.
|
|
.SH RETURN VALUE
|
|
No errors are defined in X/Open Curses.
|
|
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 prefixed with \*(``mv\*('' first perform cursor movement and
|
|
fail if the position
|
|
.RI ( y ,
|
|
.IR x )
|
|
is outside the window boundaries.
|
|
.SH NOTES
|
|
Note that all of these routines may be macros.
|
|
.SH PORTABILITY
|
|
These functions are described in X/Open Curses, Issue 4.
|
|
.SH SEE ALSO
|
|
\fB\%curs_inch\fP(3X) describes comparable functions of the
|
|
.I \%ncurses
|
|
library in its non-wide-character configuration.
|
|
.PP
|
|
\fB\%curses\fP(3X),
|
|
\fB\%curs_inwstr\fP(3X)
|