ncurses 6.2 - patch 20210109

[ncurses.git] / man / curs_getyx.3x

diff --git a/man/curs_getyx.3x b/man/curs_getyx.3x
index 8fe53dc7197275b289a0544f461ebe476a6a0b1f..e6ff67014864f15d27039d28ef6b264ca7cb16c6 100644 (file)
--- a/man/curs_getyx.3x
+++ b/man/curs_getyx.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
+.\" Copyright 2020 Thomas E. Dickey                                          *
+.\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,23 +27,23 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getyx.3x,v 1.13 2006/05/27 20:28:05 tom Exp $
+.\" $Id: curs_getyx.3x,v 1.20 2020/10/24 09:38:43 tom Exp $

 .TH curs_getyx 3X ""
 .SH NAME
 \fBgetyx\fR,
 \fBgetparyx\fR,
 \fBgetbegyx\fR,
 .TH curs_getyx 3X ""
 .SH NAME
 \fBgetyx\fR,
 \fBgetparyx\fR,
 \fBgetbegyx\fR,

-\fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates
+\fBgetmaxyx\fR \- get \fBcurses\fR cursor and window coordinates

 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp

-\fBvoid getyx(WINDOW *win, int y, int x);\fR
+\fBvoid getyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR

 .br
 .br

-\fBvoid getparyx(WINDOW *win, int y, int x);\fR
+\fBvoid getparyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR

 .br
 .br

-\fBvoid getbegyx(WINDOW *win, int y, int x);\fR
+\fBvoid getbegyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR

 .br
 .br

-\fBvoid getmaxyx(WINDOW *win, int y, int x);\fR
+\fBvoid getmaxyx(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR

 .br
 .SH DESCRIPTION
 The \fBgetyx\fR macro places the current cursor position of the given window in
 .br
 .SH DESCRIPTION
 The \fBgetyx\fR macro places the current cursor position of the given window in


@@ -51,7 +52,7 @@ the two integer variables \fIy\fR and \fIx\fR.
 If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning
 coordinates of the subwindow relative to the parent window into two integer
 variables \fIy\fR and \fIx\fR.
 If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning
 coordinates of the subwindow relative to the parent window into two integer
 variables \fIy\fR and \fIx\fR.

-Otherwise, \fB-1\fR is placed into \fIy\fR and \fIx\fR.
+Otherwise, \fB\-1\fR is placed into \fIy\fR and \fIx\fR.

 .PP
 Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store
 the current beginning coordinates and size of the specified window.
 .PP
 Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store
 the current beginning coordinates and size of the specified window.


@@ -69,7 +70,7 @@ The
 \fBgetmaxyx\fR
 macros are described in the XSI Curses standard, Issue 4.
 .PP
 \fBgetmaxyx\fR
 macros are described in the XSI Curses standard, Issue 4.
 .PP

-This implementation also provides
+This implementation also provides functions

 \fBgetbegx\fR,
 \fBgetbegy\fR,
 \fBgetcurx\fR,
 \fBgetbegx\fR,
 \fBgetbegy\fR,
 \fBgetcurx\fR,


@@ -79,13 +80,22 @@ This implementation also provides
 \fBgetparx\fR and
 \fBgetpary\fR
 for compatibility with older versions of curses.
 \fBgetparx\fR and
 \fBgetpary\fR
 for compatibility with older versions of curses.

-X/Open does not define a corresponding \fBgetcuryx\fP function,
-though that would be needed to make references to the WINDOW structure opaque.
+.PP
+Although X/Open Curses does not address this,
+many implementations provide members of the WINDOW structure
+containing values corresponding to these macros.
+For best portability, do not rely on using the data in WINDOW,
+since some implementations make WINDOW opaque (do not allow
+direct use of its members).
+.PP
+Besides the problem of opaque structures,
+the data stored in like-named members may not have like-values in
+different implementations.
+For example, the WINDOW._maxx and WINDOW._maxy values in ncurses
+have (at least since release 1.8.1) differed by one from some
+other implementations.
+The difference is hidden by means of the macro \fBgetmaxyx\fP.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurses\fR(3X),
+\fBcurs_legacy\fR(3X),
+\fBcurs_opaque\fR(3X)