usr/src/man/man3xcurses/inch.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH INCH 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 inch, mvinch, mvwinch, winch \- return a single-byte character (with rendition)
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBchtype\fR \fBinch\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBchtype\fR \fBmvinch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBchtype\fR \fBmvwinch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBchtype\fR \fBwinch\fR(\fBWINDOW *\fR\fIwin\fR);
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBinch()\fR and \fBwinch()\fR functions return the \fBchtype\fR character
  41 located at the current cursor position of the \fBstdscr\fR window  and window
  42 \fIwin\fR, respectively. The \fBmvinch()\fR and \fBmvwinch()\fR functions
  43 return the \fBchtype\fR character located at the position indicated by the
  44 \fIx\fR (column) and \fIy\fR (row) parameters (the former in the \fBstdscr\fR
  45 window; the latter in window \fIwin\fR).
  46 .sp
  47 .LP
  48 The complete character/attribute pair will be returned.  The character or
  49 attributes can be extracted by performing a bitwise \fBAND\fR on the returned
  50 value, using the constants \fBA_CHARTEXT\fR,  \fBA_ATTRIBUTES\fR, and
  51 \fBA_COLOR\fR.
  52 .SH PARAMETERS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fIy\fR\fR
  57 .ad
  58 .RS 7n
  59 Is the y (row) coordinate of the position of the character to be returned.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fIx\fR\fR
  66 .ad
  67 .RS 7n
  68 Is the x (column) coordinate of the position of the character to be returned.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fIwin\fR\fR
  75 .ad
  76 .RS 7n
  77 Is a pointer to the window that contains the character to be returned.
  78 .RE
  79
  80 .SH RETURN VALUES
  81 .sp
  82 .LP
  83 On success, these functions return the specified character and rendition.
  84 Otherwise, they return \fBERR\fR.
  85 .SH ERRORS
  86 .sp
  87 .LP
  88 None.
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Standard
 103 _
 104 MT-Level        Unsafe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBaddch\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 111 \fBattributes\fR(5), \fBstandards\fR(5)