X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getyx.3x.html;h=c734eca81184cc885c12f2f8abb68191ceff4430;hp=562d71062fd74dda5a38fe16a42997961b40af07;hb=bca50d0d8592defee6c584fdedd25f4b1a31345b;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index 562d7106..c734eca8 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,80 +1,124 @@ + + + + + +curs_getyx 3x + + + +

curs_getyx 3x

-
-
-
-

NAME

-       getyx,  getparyx,  getbegyx,  getmaxyx - get curses cursor
-       and window coordinates
-
-
-
-

SYNOPSIS

-       #include <curses.h>
-
-       void getyx(WINDOW *win, int y, int x);
-       void getparyx(WINDOW *win, int y, int x);
-       void getbegyx(WINDOW *win, int y, int x);
-       void getmaxyx(WINDOW *win, int y, int x);
+curs_getyx(3x)                                                  curs_getyx(3x)
 
 
-
-

DESCRIPTION

-       The getyx macro places the current cursor position of  the
-       given window in the two integer variables y and x.
-
-       If  win  is  a  subwindow,  the  getparyx macro places the
-       beginning coordinates of the  subwindow  relative  to  the
-       parent  window into two integer variables y and x.  Other-
-       wise, -1 is placed into y and x.
 
-       Like getyx, the getbegyx and  getmaxyx  macros  store  the
-       current  beginning  coordinates  and size of the specified
-       window.
 
+

NAME

+       getyx,  getparyx,  getbegyx,  getmaxyx  -  get curses cursor and window
+       coordinates
 
-
-

RETURN VALUE

-       The return values of these  macros  are  undefined  (i.e.,
-       they  should not be used as the right-hand side of assign-
-       ment statements).
 
+

SYNOPSIS

+       #include <curses.h>
 
-
-

NOTES

-       All of these interfaces are macros and  that  "&"  is  not
-       necessary before the variables y and x.
+       void getyx(WINDOW *win, int y, int x);
+       void getparyx(WINDOW *win, int y, int x);
+       void getbegyx(WINDOW *win, int y, int x);
+       void getmaxyx(WINDOW *win, int y, int x);
 
 
-
-

PORTABILITY

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

DESCRIPTION

+       The getyx macro places the current cursor position of the given  window
+       in the two integer variables y and x.
 
+       If  win is a subwindow, the getparyx macro places the beginning coordi-
+       nates of the subwindow relative to the parent window into  two  integer
+       variables y and x.  Otherwise, -1 is placed into y and x.
 
-
-

SEE ALSO

-       curses(3x)
+       Like  getyx,  the getbegyx and getmaxyx macros store the current begin-
+       ning coordinates and size of the specified window.
 
 
+

RETURN VALUE

+       The return values of these macros are undefined (i.e., they should  not
+       be used as the right-hand side of assignment statements).
 
 
+

NOTES

+       All  of these interfaces are macros.  A "&" is not necessary before the
+       variables y and x.
 
 
+

PORTABILITY

+       The getyx, getparyx, getbegyx and getmaxyx macros are described in  the
+       XSI Curses standard, Issue 4.
 
+       This  implementation also provides functions getbegx, getbegy, getcurx,
+       getcury, getmaxx, getmaxy, getparx and getpary for  compatibility  with
+       older versions of curses.
 
+       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 getmaxyx.
 
 
+

SEE ALSO

+       curses(3x), curs_legacy(3x), curs_opaque(3x)
 
 
 
+                                                                curs_getyx(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +