2 ****************************************************************************
3 * Copyright 2020-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2007,2010 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_getyx.3x,v 1.45 2024/05/11 20:39:53 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_getyx 3x 2024-05-11 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_getyx 3x 2024-05-11 ncurses 6.5 Library calls</H1>
44 <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG>, <STRONG>getmaxyx</STRONG> - get <EM>curses</EM> cursor and window
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>void</STRONG> <STRONG>getyx(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>
58 <STRONG>void</STRONG> <STRONG>getbegyx(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 <STRONG>void</STRONG> <STRONG>getmaxyx(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>
61 <STRONG>void</STRONG> <STRONG>getparyx(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>
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 These macros obtain the cursor position and bounds information of a
66 <EM>curses</EM> window <EM>win</EM>. <STRONG>getyx</STRONG> stores <EM>win</EM>'s cursor position in the variables
67 <EM>y</EM> and <EM>x</EM>. <STRONG>getmaxyx</STRONG> stores <EM>win</EM>'s maximum valid row and column numbers in
68 <EM>y</EM> and <EM>x</EM>, respectively. <STRONG>getbegyx</STRONG> similarly stores the position of <EM>win</EM>'s
69 origin relative to that of the screen (for <STRONG>stdscr</STRONG>, these coordinates
70 are always <STRONG>0</STRONG>).
72 If <EM>win</EM> is a subwindow (see <STRONG><A HREF="subwin.3x.html">subwin(3x)</A></STRONG>), the <STRONG>getparyx</STRONG> macro places the
73 coordinates of its origin relative to its parent window into <EM>y</EM> and <EM>x</EM>,
74 and <STRONG>-1</STRONG> into both if it is not.
77 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
78 No return values are defined for macros. Do not use them as the right-
79 hand side of assignment statements.
82 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
83 All of these interfaces are implemented as macros. An "&" operator is
84 not necessary before the variables <EM>y</EM> and <EM>x</EM>.
87 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
88 These macros are described in X/Open Curses, Issue 4.
90 <EM>ncurses</EM> also provides functions <STRONG>getbegx</STRONG>, <STRONG>getbegy</STRONG>, <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>,
91 <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG>, and <STRONG>getpary</STRONG> for compatibility with older
92 versions of <EM>curses</EM>; see <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>.
94 Although X/Open Curses does not address the issue, many implementations
95 expose members of the <EM>WINDOW</EM> structure containing values corresponding
96 to these macros. Do not rely on their availability; some
97 implementations make <EM>WINDOW</EM> opaque (that is, they do not allow direct
98 access to its members).
100 Besides the problem of opaque structures, the data stored in like-named
101 members may not have values of the same meaning different
102 implementations. For example, the values of <STRONG>WINDOW._maxx</STRONG> and
103 <STRONG>WINDOW._maxy</STRONG> in <EM>ncurses</EM> have long differed by one from some other
104 implementations. The <STRONG>getmaxyx</STRONG> macro hides this difference.
107 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>
112 ncurses 6.5 2024-05-11 <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
116 <li><a href="#h2-NAME">NAME</a></li>
117 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
118 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
119 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>