| 1 |
<!-- |
| 2 |
* t |
| 3 |
**************************************************************************** |
| 4 |
* Copyright 2018-2024,2025 Thomas E. Dickey * |
| 5 |
* Copyright 1998-2010,2017 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.70 2025/02/15 19:36:03 tom Exp @ |
| 32 |
--> |
| 33 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 34 |
<HTML> |
| 35 |
<HEAD> |
| 36 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 37 |
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> |
| 38 |
<TITLE>curs_inch 3x 2025-02-15 ncurses 6.6 Library calls</TITLE> |
| 39 |
<link rel="author" href="mailto:[email protected]"> |
| 40 |
|
| 41 |
</HEAD> |
| 42 |
<BODY> |
| 43 |
<H1 class="no-header">curs_inch 3x 2025-02-15 ncurses 6.6 Library calls</H1> |
| 44 |
<PRE> |
| 45 |
<STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> |
| 46 |
|
| 47 |
|
| 48 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 49 |
<STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a <EM>curses</EM> character from a window |
| 50 |
|
| 51 |
|
| 52 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 53 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 54 |
|
| 55 |
<STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG> |
| 56 |
<STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG> |
| 57 |
<STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG> |
| 58 |
<STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG> |
| 59 |
|
| 60 |
|
| 61 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 62 |
<STRONG>winch</STRONG> returns the <EM>curses</EM> character, including its attributes and color |
| 63 |
pair identifier, at the cursor position in the window <EM>win</EM>. Subsection |
| 64 |
"Video Attributes" of <STRONG><A HREF="curs_attr.3x.html">attron(3x)</A></STRONG> explains how to extract these data |
| 65 |
from a <EM>chtype</EM>. <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of this function. |
| 66 |
|
| 67 |
|
| 68 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 69 |
These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure. |
| 70 |
|
| 71 |
In <EM>ncurses</EM>, they return <STRONG>ERR</STRONG> if <EM>win</EM> is <EM>NULL</EM>. |
| 72 |
|
| 73 |
Functions prefixed with "mv" first perform cursor movement and fail if |
| 74 |
the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. |
| 75 |
|
| 76 |
|
| 77 |
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |
| 78 |
<STRONG>inch</STRONG>, <STRONG>mvinch</STRONG>, and <STRONG>mvwinch</STRONG> may be implemented as macros. |
| 79 |
|
| 80 |
These functions do not fail if the window contains cells of <EM>curses</EM> |
| 81 |
complex characters; that is, if they contain characters with codes |
| 82 |
wider than eight bits (or greater than 255 as an unsigned decimal |
| 83 |
integer). They instead extract only the low-order eight bits of the |
| 84 |
character code from the cell. |
| 85 |
|
| 86 |
|
| 87 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 88 |
X/Open Curses Issue 4 describes these functions. It specifies no error |
| 89 |
conditions for them. |
| 90 |
|
| 91 |
|
| 92 |
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> |
| 93 |
The original <EM>curses</EM> in 4BSD (1980) defined <EM>winch</EM> as a macro accessing |
| 94 |
the <EM>WINDOW</EM> structure member representing character cell data, at that |
| 95 |
time a <EM>char</EM>, containing only a 7-bit ASCII character code and a |
| 96 |
"standout" attribute bit, the only one the library supported. |
| 97 |
|
| 98 |
SVr2 <EM>curses</EM> (1984) extended this approach, widening the character code |
| 99 |
to eight bits and permitting several attributes to be combined with it |
| 100 |
by storing them together in a <EM>chtype</EM>, an alias of <EM>unsigned</EM> <EM>short</EM>. |
| 101 |
Because a macro was used, its value was not type-checked as a function |
| 102 |
return value could have been. Goodheart documented SVr3 (1987) <EM>winch</EM> |
| 103 |
as returning an <EM>int</EM>. SVr3.1's (1987) <EM>chtype</EM> became an alias of |
| 104 |
<EM>unsigned</EM> <EM>long</EM>, using 16 bits for the character code and widening the |
| 105 |
type in practical terms to 32 bits, as 64-bit Unix systems were not yet |
| 106 |
in wide use, and fixed-width integral types would not be standard until |
| 107 |
ISO C99. SVr3.2 (1988) added a 6-bit color pair identifier alongside |
| 108 |
the attributes. |
| 109 |
|
| 110 |
|
| 111 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 112 |
<STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> library |
| 113 |
in its wide-character configuration (<EM>ncursesw</EM>). |
| 114 |
|
| 115 |
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG> |
| 116 |
|
| 117 |
ncurses 6.6 2025-02-15 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG> |
| 118 |
</PRE> |
| 119 |
<div class="nav"> |
| 120 |
<ul> |
| 121 |
<li><a href="#h2-NAME">NAME</a></li> |
| 122 |
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 123 |
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> |
| 124 |
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> |
| 125 |
<li><a href="#h2-NOTES">NOTES</a></li> |
| 126 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 127 |
<li><a href="#h2-HISTORY">HISTORY</a></li> |
| 128 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 129 |
</ul> |
| 130 |
</div> |
| 131 |
</BODY> |
| 132 |
</HTML> |