ncurses 6.2 - patch 20201205
[ncurses.git] / man / curs_getyx.3x
1 .\"***************************************************************************
2 .\" Copyright 2020 Thomas E. Dickey                                          *
3 .\" Copyright 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 .\"
30 .\" $Id: curs_getyx.3x,v 1.20 2020/10/24 09:38:43 tom Exp $
31 .TH curs_getyx 3X ""
32 .SH NAME
33 \fBgetyx\fR,
34 \fBgetparyx\fR,
35 \fBgetbegyx\fR,
36 \fBgetmaxyx\fR \- get \fBcurses\fR cursor and window coordinates
37 .SH SYNOPSIS
38 \fB#include <curses.h>\fR
39 .sp
40 \fBvoid getyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
41 .br
42 \fBvoid getparyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
43 .br
44 \fBvoid getbegyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
45 .br
46 \fBvoid getmaxyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
47 .br
48 .SH DESCRIPTION
49 The \fBgetyx\fR macro places the current cursor position of the given window in
50 the two integer variables \fIy\fR and \fIx\fR.
51 .PP
52 If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning
53 coordinates of the subwindow relative to the parent window into two integer
54 variables \fIy\fR and \fIx\fR.
55 Otherwise, \fB\-1\fR is placed into \fIy\fR and \fIx\fR.
56 .PP
57 Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store
58 the current beginning coordinates and size of the specified window.
59 .SH RETURN VALUE
60 The return values of these macros are undefined (i.e.,
61 they should not be used as the right-hand side of assignment statements).
62 .SH NOTES
63 All of these interfaces are macros.
64 A "\fB&\fR" is not necessary before the variables \fIy\fR and \fIx\fR.
65 .SH PORTABILITY
66 The
67 \fBgetyx\fR,
68 \fBgetparyx\fR,
69 \fBgetbegyx\fR and
70 \fBgetmaxyx\fR
71 macros are described in the XSI Curses standard, Issue 4.
72 .PP
73 This implementation also provides functions
74 \fBgetbegx\fR,
75 \fBgetbegy\fR,
76 \fBgetcurx\fR,
77 \fBgetcury\fR,
78 \fBgetmaxx\fR,
79 \fBgetmaxy\fR,
80 \fBgetparx\fR and
81 \fBgetpary\fR
82 for compatibility with older versions of curses.
83 .PP
84 Although X/Open Curses does not address this,
85 many implementations provide members of the WINDOW structure
86 containing values corresponding to these macros.
87 For best portability, do not rely on using the data in WINDOW,
88 since some implementations make WINDOW opaque (do not allow
89 direct use of its members).
90 .PP
91 Besides the problem of opaque structures,
92 the data stored in like-named members may not have like-values in
93 different implementations.
94 For example, the WINDOW._maxx and WINDOW._maxy values in ncurses
95 have (at least since release 1.8.1) differed by one from some
96 other implementations.
97 The difference is hidden by means of the macro \fBgetmaxyx\fP.
98 .SH SEE ALSO
99 \fBcurses\fR(3X),
100 \fBcurs_legacy\fR(3X),
101 \fBcurs_opaque\fR(3X)