ncurses 6.0 - patch 20160820
[ncurses.git] / doc / html / man / curs_getyx.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_getyx.3x,v 1.18 2010/12/04 18:36:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_getyx 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_getyx 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>                                           <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>,  <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor
50        and window coordinates
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
57        <STRONG>void</STRONG> <STRONG>getparyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
58        <STRONG>void</STRONG> <STRONG>getbegyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
59        <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The <STRONG>getyx</STRONG> macro places the current cursor position of  the
64        given window in the two integer variables <EM>y</EM> and <EM>x</EM>.
65
66        If  <EM>win</EM>  is  a  subwindow,  the  <STRONG>getparyx</STRONG> macro places the
67        beginning coordinates of the  subwindow  relative  to  the
68        parent  window into two integer variables <EM>y</EM> and <EM>x</EM>.  Other-
69        wise, <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
72        current  beginning  coordinates  and size of the specified
73        window.
74
75
76 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
77        The return values of these  macros  are  undefined  (i.e.,
78        they  should not be used as the right-hand side of assign-
79        ment statements).
80
81
82 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
83        All of these interfaces are macros.  A "<STRONG>&amp;</STRONG>" is  not  neces-
84        sary before the variables <EM>y</EM> and <EM>x</EM>.
85
86
87 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
88        The  <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>  and  <STRONG>getmaxyx</STRONG> macros are
89        described in the XSI Curses standard, Issue 4.
90
91        This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getb-</STRONG>
92        <STRONG>egy</STRONG>,  <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>get-</STRONG>
93        <STRONG>pary</STRONG> for compatibility with older versions of curses.
94
95        Although X/Open Curses does not address this, many  imple-
96        mentations  provide  members  of the WINDOW structure con-
97        taining values corresponding to these  macros.   For  best
98        portability,  do  not  rely  on  using the data in WINDOW,
99        since some implementations  make  WINDOW  opaque  (do  not
100        allow direct use of its members).
101
102        Besides  the problem of opaque structures, the data stored
103        in like-named members may not have like-values in  differ-
104        ent  implementations.   For  example, the WINDOW._maxx and
105        WINDOW._maxy  values  in  ncurses  have  (at  least  since
106        release 1.8.1) differed by one from some other implementa-
107        tions.  The difference is hidden by  means  of  the  macro
108        <STRONG>getmaxyx</STRONG>.
109
110
111 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
112        <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>
113
114
115
116                                                          <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
117 </PRE>
118 <div class="nav">
119 <ul>
120 <li><a href="#h2-NAME">NAME</a></li>
121 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
122 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
123 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
124 <li><a href="#h2-NOTES">NOTES</a></li>
125 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
127 </ul>
128 </div>
129 </BODY>
130 </HTML>