doc/html/man/curs_inch.3x.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>curs_inch 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>curs_inch 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>                                             <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>inch</STRONG>,  <STRONG>winch</STRONG>,  <STRONG>mvinch</STRONG>,  <STRONG>mvwinch</STRONG>  -  get  a  character  and
  52        attributes from a <STRONG>curses</STRONG> window
  53
  54
  55 </PRE>
  56 <H2>SYNOPSIS</H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  58
  59        <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
  60        <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*win);</STRONG>
  61        <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
  62        <STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
  63
  64
  65 </PRE>
  66 <H2>DESCRIPTION</H2><PRE>
  67        These routines return the character, of  type  <STRONG>chtype</STRONG>,  at
  68        the   current  position  in  the  named  window.   If  any
  69        attributes are set for that  position,  their  values  are
  70        OR'ed  into  the  value  returned.   Constants  defined in
  71        <STRONG>&lt;curses.h&gt;</STRONG> can be used with the <STRONG>&amp;</STRONG> (logical  AND)  operator
  72        to extract the character or attributes alone.
  73
  74    <STRONG>Attributes</STRONG>
  75        The  following  bit-masks  may  be  AND-ed with characters
  76        returned by <STRONG>winch</STRONG>.
  77
  78        <STRONG>A_CHARTEXT</STRONG>     Bit-mask to extract character
  79        <STRONG>A_ATTRIBUTES</STRONG>   Bit-mask to extract attributes
  80        <STRONG>A_COLOR</STRONG>        Bit-mask to extract color-pair field information
  81
  82
  83 </PRE>
  84 <H2>RETURN VALUE</H2><PRE>
  85        Functions with a "mv" prefix first perform a cursor  move-
  86        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
  87        outside the window, or if the window pointer is null.
  88
  89
  90 </PRE>
  91 <H2>NOTES</H2><PRE>
  92        Note that all of these routines may be macros.
  93
  94
  95 </PRE>
  96 <H2>PORTABILITY</H2><PRE>
  97        These functions are described in the XSI Curses  standard,
  98        Issue 4.
  99
 100
 101 </PRE>
 102 <H2>SEE ALSO</H2><PRE>
 103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 104
 105        Comparable  functions  in  the  wide-character  (ncursesw)
 106        library are described in <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>.
 107
 108
 109
 110                                                           <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
 111 </PRE>
 112 <HR>
 113 <ADDRESS>
 114 Man(1) output converted with
 115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 116 </ADDRESS>
 117 </BODY>
 118 </HTML>