-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
+ * Copyright 2018-2020,2021 Thomas E. Dickey *
+ * Copyright 1998-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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp @
+ * @Id: curs_inch.3x,v 1.26 2021/06/17 21:30:22 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_inch 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_inch 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">curs_inch 3x</H1>
+<H1 class="no-header">curs_inch 3X</H1>
<PRE>
-<STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
+<B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B> <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a character and attributes from a
- <STRONG>curses</STRONG> window
+ <B>inch</B>, <B>winch</B>, <B>mvinch</B>, <B>mvwinch</B> - get a character and attributes from a
+ <B>curses</B> window
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <B>#include</B> <B><curses.h></B>
- <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
- <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*win);</STRONG>
- <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
- <STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
+ <B>chtype</B> <B>inch(void);</B>
+ <B>chtype</B> <B>winch(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+
+ <B>chtype</B> <B>mvinch(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
+ <B>chtype</B> <B>mvwinch(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- These routines return the character, of type <STRONG>chtype</STRONG>, at the current
- position in the named window. If any attributes are set for that posi-
- tion, their values are OR'ed into the value returned. Constants
- defined in <STRONG><curses.h></STRONG> can be used with the <STRONG>&</STRONG> (logical AND) operator to
+ These routines return the character, of type <B>chtype</B>, at the current
+ position in the named window. If any attributes are set for that
+ position, their values are OR'ed into the value returned. Constants
+ defined in <B><curses.h></B> can be used with the <B>&</B> (logical AND) operator to
extract the character or attributes alone.
</PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>
The following bit-masks may be AND-ed with characters returned by
- <STRONG>winch</STRONG>.
+ <B>winch</B>.
- <STRONG>A_CHARTEXT</STRONG> Bit-mask to extract character
- <STRONG>A_ATTRIBUTES</STRONG> Bit-mask to extract attributes
- <STRONG>A_COLOR</STRONG> Bit-mask to extract color-pair field information
+ <B>A_CHARTEXT</B> Bit-mask to extract character
+ <B>A_ATTRIBUTES</B> Bit-mask to extract attributes
+ <B>A_COLOR</B> Bit-mask to extract color-pair field information
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Functions with a "mv" prefix first perform a cursor movement using
- <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
+ <B>wmove</B>, and return an error if the position is outside the window, or if
the window pointer is null.
+ The <B>winch</B> function does not return an error if the window contains
+ characters larger than 8-bits (255). Only the low-order 8 bits of the
+ character are used by <B>winch</B>.
+
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Note that all of these routines may be macros.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
These functions are described in the XSI Curses standard, Issue 4.
+ Very old systems (before standardization) provide a different function
+ with the same name:
+
+ <B>o</B> The <B>winch</B> function was part of the original BSD curses library,
+ which stored a 7-bit character combined with the <I>standout</I>
+ attribute.
+
+ In BSD curses, <B>winch</B> returned only the character (as an integer)
+ with the <I>standout</I> attribute removed.
+
+ <B>o</B> System V curses added support for several video attributes which
+ could be combined with characters in the window.
+
+ Reflecting this improvement, the function was altered to return the
+ character combined with all video attributes in a <B>chtype</B> value.
+
+ X/Open Curses does not specify the size and layout of attributes, color
+ and character values in <B>chtype</B>; it is implementation-dependent. This
+ implementation uses 8 bits for character values. An application using
+ more bits, e.g., a Unicode value, should use the wide-character
+ equivalents to these functions.
+
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>
+ gives an overview of the WINDOW and <B>chtype</B> data types.
+
+ <B><A HREF="curs_attr.3X.html">curs_attr(3X)</A></B>
+ goes into more detail, pointing out portability problems and
+ constraints on the use of <B>chtype</B> for returning window information.
- Comparable functions in the wide-character (ncursesw) library are
- described in <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>.
+ <B><A HREF="curs_in_wch.3X.html">curs_in_wch(3X)</A></B>
+ describes comparable functions for the wide-character (ncursesw)
+ library.
- <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
+ <B><A HREF="curs_inch.3X.html">curs_inch(3X)</A></B>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff