diff options
Diffstat (limited to 'doc/html/man/curs_getyx.3x.html')
| -rw-r--r-- | doc/html/man/curs_getyx.3x.html | 121 |
1 files changed, 59 insertions, 62 deletions
diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index f5b379f..994e0f7 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2007,2010 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 * @@ -27,32 +27,31 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_getyx.3x,v 1.18 2010/12/04 18:36:44 tom Exp @ + * @Id: curs_getyx.3x,v 1.19 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_getyx 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_getyx 3x</H1> -<HR> +<H1 class="no-header">curs_getyx 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> +<STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG>, <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor - and window coordinates +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG>, <STRONG>getmaxyx</STRONG> - get <STRONG>curses</STRONG> cursor and window + coordinates -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>void</STRONG> <STRONG>getyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> @@ -61,68 +60,66 @@ <STRONG>void</STRONG> <STRONG>getmaxyx(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>getyx</STRONG> macro places the current cursor position of the - given window in the two integer variables <EM>y</EM> and <EM>x</EM>. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + The <STRONG>getyx</STRONG> macro places the current cursor position of the given window + in the two integer variables <EM>y</EM> and <EM>x</EM>. - If <EM>win</EM> is a subwindow, the <STRONG>getparyx</STRONG> macro places the - beginning coordinates of the subwindow relative to the - parent window into two integer variables <EM>y</EM> and <EM>x</EM>. Other- - wise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>. + If <EM>win</EM> is a subwindow, the <STRONG>getparyx</STRONG> macro places the beginning coordi- + nates of the subwindow relative to the parent window into two integer + variables <EM>y</EM> and <EM>x</EM>. Otherwise, <STRONG>-1</STRONG> is placed into <EM>y</EM> and <EM>x</EM>. - Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros store the - current beginning coordinates and size of the specified - window. + Like <STRONG>getyx</STRONG>, the <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros store the current begin- + ning coordinates and size of the specified window. -</PRE> -<H2>RETURN VALUE</H2><PRE> - The return values of these macros are undefined (i.e., - they should not be used as the right-hand side of assign- - ment statements). +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + The return values of these macros are undefined (i.e., they should not + be used as the right-hand side of assignment statements). -</PRE> -<H2>NOTES</H2><PRE> - All of these interfaces are macros. A "<STRONG>&</STRONG>" is not neces- - sary before the variables <EM>y</EM> and <EM>x</EM>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + All of these interfaces are macros. A "<STRONG>&</STRONG>" is not necessary before the + variables <EM>y</EM> and <EM>x</EM>. -</PRE> -<H2>PORTABILITY</H2><PRE> - The <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros are - described in the XSI Curses standard, Issue 4. - - This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getb-</STRONG> - <STRONG>egy</STRONG>, <STRONG>getcurx</STRONG>, <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>get-</STRONG> - <STRONG>pary</STRONG> for compatibility with older versions of curses. - - Although X/Open Curses does not address this, many imple- - mentations provide members of the WINDOW structure con- - taining 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). - - Besides the problem of opaque structures, the data stored - in like-named members may not have like-values in differ- - ent 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 implementa- - tions. The difference is hidden by means of the macro - <STRONG>getmaxyx</STRONG>. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + The <STRONG>getyx</STRONG>, <STRONG>getparyx</STRONG>, <STRONG>getbegyx</STRONG> and <STRONG>getmaxyx</STRONG> macros are described in the + XSI Curses standard, Issue 4. + This implementation also provides functions <STRONG>getbegx</STRONG>, <STRONG>getbegy</STRONG>, <STRONG>getcurx</STRONG>, + <STRONG>getcury</STRONG>, <STRONG>getmaxx</STRONG>, <STRONG>getmaxy</STRONG>, <STRONG>getparx</STRONG> and <STRONG>getpary</STRONG> for compatibility with + older versions of curses. -</PRE> -<H2>SEE ALSO</H2><PRE> + Although X/Open Curses does not address this, many implementations pro- + vide 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). + + 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 implementa- + tions. The difference is hidden by means of the macro <STRONG>getmaxyx</STRONG>. + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <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> - <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> + <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |