ncurses 5.7 - patch 20110108
[ncurses.git] / doc / html / man / curs_getyx.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 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.18 2010/12/04 18:36:44 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_getyx 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_getyx 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
49 <H2>NAME</H2><PRE>
50        <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>,  <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor
51        and window coordinates
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
59        <STRONG>void</STRONG> <STRONG>getparyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
60        <STRONG>void</STRONG> <STRONG>getbegyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
61        <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
62
63
64 </PRE>
65 <H2>DESCRIPTION</H2><PRE>
66        The <STRONG>getyx</STRONG> macro places the current cursor position of  the
67        given window in the two integer variables <EM>y</EM> and <EM>x</EM>.
68
69        If  <EM>win</EM>  is  a  subwindow,  the  <STRONG>getparyx</STRONG> macro places the
70        beginning coordinates of the  subwindow  relative  to  the
71        parent  window into two integer variables <EM>y</EM> and <EM>x</EM>.  Other-
72        wise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>.
73
74        Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and  <STRONG>getmaxyx</STRONG>  macros  store  the
75        current  beginning  coordinates  and size of the specified
76        window.
77
78
79 </PRE>
80 <H2>RETURN VALUE</H2><PRE>
81        The return values of these  macros  are  undefined  (i.e.,
82        they  should not be used as the right-hand side of assign-
83        ment statements).
84
85
86 </PRE>
87 <H2>NOTES</H2><PRE>
88        All of these interfaces are macros.  A "<STRONG>&amp;</STRONG>" is  not  neces-
89        sary before the variables <EM>y</EM> and <EM>x</EM>.
90
91
92 </PRE>
93 <H2>PORTABILITY</H2><PRE>
94        The  <STRONG>getyx</STRONG>,  <STRONG>getparyx</STRONG>,  <STRONG>getbegyx</STRONG>  and  <STRONG>getmaxyx</STRONG> macros are
95        described in the XSI Curses standard, Issue 4.
96
97        This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getb-</STRONG>
98        <STRONG>egy</STRONG>,  <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>get-</STRONG>
99        <STRONG>pary</STRONG> for compatibility with older versions of curses.
100
101        Although X/Open Curses does not address this, many  imple-
102        mentations  provide  members  of the WINDOW structure con-
103        taining values corresponding to these  macros.   For  best
104        portability,  do  not  rely  on  using the data in WINDOW,
105        since some implementations  make  WINDOW  opaque  (do  not
106        allow direct use of its members).
107
108        Besides  the problem of opaque structures, the data stored
109        in like-named members may not have like-values in  differ-
110        ent  implementations.   For  example, the WINDOW._maxx and
111        WINDOW._maxy  values  in  ncurses  have  (at  least  since
112        release 1.8.1) differed by one from some other implementa-
113        tions.  The difference is hidden by  means  of  the  macro
114        <STRONG>getmaxyx</STRONG>.
115
116
117 </PRE>
118 <H2>SEE ALSO</H2><PRE>
119        <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>
120
121
122
123                                                          <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
124 </PRE>
125 <HR>
126 <ADDRESS>
127 Man(1) output converted with
128 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
129 </ADDRESS>
130 </BODY>
131 </HTML>