X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_in_wch.3x;h=e2678997b4c662fed82e286ea4a7d3a4a9b9841f;hp=6b3e53efca1b7d774144e171d977bbbf1c49427c;hb=HEAD;hpb=9bb12d03d854ce72b456e525f0c560f2fa91545d diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x index 6b3e53ef..8512e6d3 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2006,2010 Free Software Foundation, Inc. * +.\" 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 * @@ -26,47 +27,58 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.4 2010/08/14 23:29:16 tom Exp $ -.TH curs_in_wch 3X "" +.\" $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 -\fBin_wch\fR, -\fBmvin_wch\fR, -\fBmvwin_wch\fR, -\fBwin_wch\fR \- extract a complex character and rendition from a window +\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 -\fB#include \fR -.sp -\fBint in_wch(cchar_t *\fR\fIwcval\fR\fB);\fR -.br -\fBint mvin_wch(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR -.br -\fBint mvwin_wch(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR -.br -\fBint win_wch(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR +.nf +\fB#include +.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\fR object -referenced by wcval. +the current position in the named window into the \fBcchar_t\fP object +referenced by wch. .SH RETURN VALUE -No errors are defined in the XSI Curses standard. -This implementation checks for null pointers, returns ERR in that case. -Also, the \fImv\fR routines check for error moving the cursor, returning ERR -in that case. -Otherwise they return OK +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 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. +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 the XSI Curses standard, Issue 4. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_inch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\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)