1<!-- 2 **************************************************************************** 3 * Copyright 2020-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2007,2010 Free Software Foundation, Inc. * 5 * * 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: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 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. * 24 * * 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 * 28 * authorization. * 29 **************************************************************************** 30 * @Id: curs_getyx.3x,v 1.44 2024/04/20 21:20:07 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 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-04-20 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">curs_getyx 3x 2024-04-20 ncurses 6.5 Library calls</H1> 43<PRE> 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> 45 46 47 48 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 51 coordinates 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 56 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>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> 59 <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> 60 <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 62 63</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 64 The <STRONG>getyx</STRONG> macro places the current cursor position of the given window 65 in the two integer variables <EM>y</EM> and <EM>x</EM>. 66 67 If <EM>win</EM> is a subwindow, the <STRONG>getparyx</STRONG> macro places the beginning 68 coordinates of the subwindow relative to the parent window into two 69 integer variables <EM>y</EM> and <EM>x</EM>. Otherwise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>. 70 71 Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros store the current 72 beginning coordinates and size of the specified window. 73 74 75</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 76 The return values of these macros are undefined (i.e., they should not 77 be used as the right-hand side of assignment statements). 78 79 80</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> 81 All of these interfaces are macros. A "&" is not necessary before the 82 variables <EM>y</EM> and <EM>x</EM>. 83 84 85</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 86 The <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros are described in 87 X/Open Curses, Issue 4. 88 89 This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getbegy</STRONG>, <STRONG>getcurx</STRONG>, 90 <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>getpary</STRONG> for compatibility with 91 older versions of <EM>curses</EM>; see <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>. 92 93 Although X/Open Curses does not address this, many implementations 94 provide members of the <STRONG>WINDOW</STRONG> structure containing values corresponding 95 to these macros. For best portability, do not rely on using the data 96 in <STRONG>WINDOW</STRONG>, since some implementations make <STRONG>WINDOW</STRONG> opaque (do not allow 97 direct use of its members). 98 99 Besides the problem of opaque structures, the data stored in like-named 100 members may not have like-values in different implementations. For 101 example, the <STRONG>WINDOW._maxx</STRONG> and <STRONG>WINDOW._maxy</STRONG> values in <EM>ncurses</EM> have (at 102 least since release 1.8.1) differed by one from some other 103 implementations. The difference is hidden by means of the macro 104 <STRONG>getmaxyx</STRONG>. 105 106 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> 109 110 111 112ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> 113</PRE> 114<div class="nav"> 115<ul> 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> 123</ul> 124</div> 125</BODY> 126</HTML> 127