usr/src/man/man3curses/curs_inwch.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH CURS_INWCH 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_inwch, inwch, winwch, mvinwch, mvwinwch \- get a wchar_t character and its
  10 attributes from a curses window
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR .. ]
  15 #include <curses.h>
  16
  17 \fBchtype\fR \fBinwch\fR(\fBvoid\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBchtype\fR \fBwinwch\fR(\fBWINDOW *\fR\fIwin\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBchtype\fR \fBmvinwch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBchtype\fR \fBmvwinwch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 These routines return the  \fBwchar_t\fR character, of type  \fBchtype\fR, at
  39 the current position in the named window. If any attributes are set for that
  40 position, their values are OR-ed into the value returned. Constants defined in
  41 \fB<curses.h>\fR can be used with the  logical AND (\fB&\fR) operator to
  42 extract the character or attributes alone.
  43 .SS "Attributes"
  44 .sp
  45 .LP
  46 The following bit-masks may be AND-ed with characters returned by
  47 \fBwinwch()\fR.
  48 .sp
  49 .in +2
  50 .nf
  51 A_WCHARTEXT          Bit-mask to extract character
  52 A_WATTRIBUTES        Bit-mask to extract attributes
  53 .fi
  54 .in -2
  55
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5) for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 MT-Level        Unsafe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
  76 .SH NOTES
  77 .sp
  78 .LP
  79 The header file <\fBcurses.h\fR> automatically includes the header files
  80 <\fBstdio.h\fR>, <\fBunctrl.h\fR> and <\fBwidec.h\fR>.
  81 .sp
  82 .LP
  83 Note that all of these routines may be macros.
  84 .sp
  85 .LP
  86 None of these routines can use the color attribute in \fBchtype\fR.