ncurses 5.6 - patch 20070217

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

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

-.\" Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1998-2003,2006 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,24 +26,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getyx.3x,v 1.8 2002/09/21 19:00:38 tom Exp $
+.\" $Id: curs_getyx.3x,v 1.13 2006/05/27 20:28:05 tom Exp $

 .TH curs_getyx 3X ""
 .SH NAME
 .TH curs_getyx 3X ""
 .SH NAME

-.IX getbegx
-.IX getbegy
-.IX getcurx
-.IX getcury
-.IX getmaxx
-.IX getmaxy
-.IX getparx
-.IX getpary

 \fBgetyx\fR,
 \fBgetparyx\fR,
 \fBgetbegyx\fR,
 \fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 \fBgetyx\fR,
 \fBgetparyx\fR,
 \fBgetbegyx\fR,
 \fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates
 .SH SYNOPSIS
 \fB#include <curses.h>\fR

-
+.sp

 \fBvoid getyx(WINDOW *win, int y, int x);\fR
 .br
 \fBvoid getparyx(WINDOW *win, int y, int x);\fR
 \fBvoid getyx(WINDOW *win, int y, int x);\fR
 .br
 \fBvoid getparyx(WINDOW *win, int y, int x);\fR


@@ -55,16 +47,16 @@
 .SH DESCRIPTION
 The \fBgetyx\fR macro places the current cursor position of the given window in
 the two integer variables \fIy\fR and \fIx\fR.
 .SH DESCRIPTION
 The \fBgetyx\fR macro places the current cursor position of the given window in
 the two integer variables \fIy\fR and \fIx\fR.

-
+.PP

 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.
 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.

-
+.PP

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

-The return values of these macros are undefined (\fIi\fR.\fIe\fR.,
+The return values of these macros are undefined (i.e.,

 they should not be used as the right-hand side of assignment statements).
 .SH NOTES
 All of these interfaces are macros.
 they should not be used as the right-hand side of assignment statements).
 .SH NOTES
 All of these interfaces are macros.


@@ -75,7 +67,7 @@ The
 \fBgetparyx\fR,
 \fBgetbegyx\fR and
 \fBgetmaxyx\fR
 \fBgetparyx\fR,
 \fBgetbegyx\fR and
 \fBgetmaxyx\fR

-functions are described in the XSI Curses standard, Issue 4.
+macros are described in the XSI Curses standard, Issue 4.

 .PP
 This implementation also provides
 \fBgetbegx\fR,
 .PP
 This implementation also provides
 \fBgetbegx\fR,


@@ -87,6 +79,8 @@ 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.

 .SH SEE ALSO
 \fBcurses\fR(3X)
 .\"#
 .SH SEE ALSO
 \fBcurses\fR(3X)
 .\"#