820bf99c5327890f69a945a94dc47f9e098346a0
[ncurses.git] / man / curs_getyx.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_getyx.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
30 .TH curs_getyx 3X ""
31 .SH NAME
32 \fBgetyx\fR, \fBgetparyx\fR, \fBgetbegyx\fR,
33 \fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates
34 .SH SYNOPSIS
35 \fB#include <curses.h>\fR
36
37 \fBvoid getyx(WINDOW *win, int y, int x);\fR
38 .br
39 \fBvoid getparyx(WINDOW *win, int y, int x);\fR
40 .br
41 \fBvoid getbegyx(WINDOW *win, int y, int x);\fR
42 .br
43 \fBvoid getmaxyx(WINDOW *win, int y, int x);\fR
44 .br
45 .SH DESCRIPTION
46 The \fBgetyx\fR macro places the current cursor position of the given window in
47 the two integer variables \fIy\fR and \fIx\fR.
48
49 If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning
50 coordinates of the subwindow relative to the parent window into two integer
51 variables \fIy\fR and \fIx\fR.  Otherwise, \fB-1\fR is placed into \fIy\fR and
52 \fIx\fR.
53
54 Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store
55 the current beginning coordinates and size of the specified window.
56 .SH RETURN VALUE
57 The return values of these macros are undefined (\fIi\fR.\fIe\fR.,
58 they should not be used as the right-hand side of assignment
59 statements).
60 .SH NOTES
61 All of these interfaces are macros and that "\fB&\fR" is not
62 necessary before the variables \fIy\fR and \fIx\fR.
63 .SH PORTABILITY
64 These functions are described in the XSI Curses standard, Issue 4.
65 .SH SEE ALSO
66 \fBcurses\fR(3X)
67 .\"#
68 .\"# The following sets edit modes for GNU EMACS
69 .\"# Local Variables:
70 .\"# mode:nroff
71 .\"# fill-column:79
72 .\"# End: