X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getyx.3x.html;h=d86ff695f15749ef2f90d5111dd47bfde3030994;hp=562d71062fd74dda5a38fe16a42997961b40af07;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index 562d7106..d86ff695 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,75 +1,126 @@ + + + +curs_getyx 3x + + + +

curs_getyx 3x

 
+curs_getyx(3x)                                           curs_getyx(3x)
+
+
+

NAME

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

SYNOPSIS

-       #include <curses.h>
+       #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);
+       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);

DESCRIPTION

-       The getyx macro places the current cursor position of  the
-       given window in the two integer variables y and x.
+       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
+       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.
+       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
+       Like getyx, the getbegyx and  getmaxyx  macros  store  the
        current  beginning  coordinates  and size of the specified
        window.

RETURN VALUE

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

NOTES

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

PORTABILITY

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

-       curses(3x)
-
-
-
-
-
-
+       The  getyx,  getparyx,  getbegyx  and  getmaxyx macros are
+       described in the XSI Curses standard, Issue 4.
 
+       This implementation also provides functions getbegx, getb-
+       egy,  getcurx, getcury, getmaxx, getmaxy, getparx and get-
+       pary 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
+       getmaxyx.
 
 
+