man/curs_in_wch.3x

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
   3 .\" Copyright 2002-2010,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: curs_in_wch.3x,v 1.33 2024/05/18 20:19:38 tom Exp $
  31 .TH curs_in_wch 3X 2024-05-18 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .SH NAME
  43 \fB\%in_wch\fP,
  44 \fB\%mvin_wch\fP,
  45 \fB\%mvwin_wch\fP,
  46 \fB\%win_wch\fP \-
  47 get a \fIcurses\fR complex character from a window
  48 .SH SYNOPSIS
  49 .nf
  50 \fB#include <curses.h>
  51 .PP
  52 \fBint in_wch(cchar_t * \fIwch\fP);
  53 \fBint win_wch(WINDOW * \fIwin\fP, cchar_t * \fIwch\fP);
  54 \fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t * \fIwch\fP);
  55 \fBint mvwin_wch(WINDOW * \fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t * \fIwch\fP);
  56 .fi
  57 .SH DESCRIPTION
  58 .B \%win_wch
  59 copies the
  60 .I curses
  61 complex character at the cursor position in
  62 .I win
  63 into
  64 .IR wch "."
  65 Use \fB\%getcchar\fP(3X) to extract its character code,
  66 attributes,
  67 and color pair identifier.
  68 \fB\%ncurses\fP(3X) describes the variants of this function.
  69 .SH RETURN VALUE
  70 These functions return
  71 .B OK
  72 on success and
  73 .B ERR
  74 on failure.
  75 .PP
  76 In
  77 .IR \%ncurses ","
  78 .B \%win_wch
  79 returns
  80 .B ERR
  81 if
  82 .I win
  83 is
  84 .BR NULL "."
  85 .PP
  86 Functions prefixed with \*(``mv\*('' first perform cursor movement and
  87 fail if the position
  88 .RI ( y ,
  89 .IR x )
  90 is outside the window boundaries.
  91 .SH NOTES
  92 .BR \%in_wch ","
  93 .BR mvin_wch ","
  94 and
  95 .B mvwin_wch
  96 may be implemented as macros.
  97 .PP
  98 Unlike \fB\%winch\fP(3X),
  99 .B \%win_wch
 100 and its variants store the value of the retrieved character in an
 101 additional
 102 .I wch
 103 parameter instead of the return value.
 104 .SH PORTABILITY
 105 X/Open Curses,
 106 Issue 4 describes these functions.
 107 It specifies no error conditions for them.
 108 .SH SEE ALSO
 109 \fB\%curs_inch\fP(3X) describes comparable functions of the
 110 .I \%ncurses
 111 library in its non-wide-character configuration.
 112 .PP
 113 \fB\%curses\fP(3X),
 114 \fB\%curs_inwstr\fP(3X)