X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getyx.3x.html;h=bc69247f02a319b57256f36d2bd65f4ee7c6155b;hp=6d4a62e8f00739a51373ddd542b1c6f34266da95;hb=HEAD;hpb=0eedaa5673ff8181abe51e3a6fadca3820f90c46 diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index 6d4a62e8..fa30badb 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,6 +1,6 @@ -curs_getyx 3x 2023-09-23 ncurses 6.4 Library calls +curs_getyx 3x 2024-05-11 ncurses 6.5 Library calls -

curs_getyx 3x 2023-09-23 ncurses 6.4 Library calls

+

curs_getyx 3x 2024-05-11 ncurses 6.5 Library calls

 curs_getyx(3x)                   Library calls                  curs_getyx(3x)
 
@@ -55,53 +55,53 @@
        #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 getparyx(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.
-
-       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.  Otherwise, -1 is placed into y and x.
+       These macros obtain the cursor position and  bounds  information  of  a
+       curses window win.  getyx stores win's cursor position in the variables
+       y and x.  getmaxyx stores win's maximum valid row and column numbers in
+       y and x, respectively.  getbegyx similarly stores the position of win's
+       origin relative to that of the screen (for  stdscr,  these  coordinates
+       are always 0).
 
-       Like  getyx,  the  getbegyx  and  getmaxyx  macros  store  the  current
-       beginning coordinates and size of the specified window.
+       If  win  is a subwindow (see subwin(3x)), the getparyx macro places the
+       coordinates of its origin relative to its parent window into y  and  x,
+       and -1 into both if it is not.

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).
+       No return values are defined for macros.  Do not use them 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.
+       All of these interfaces are implemented as macros.  An "&" operator  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.
+       These macros are described in X/Open Curses, Issue 4.
 
-       This  implementation also provides functions getbegx, getbegy, getcurx,
-       getcury, getmaxx, getmaxy, getparx and getpary for  compatibility  with
-       older versions of curses; see curs_legacy(3x).
+       ncurses  also  provides  functions  getbegx, getbegy, getcurx, getcury,
+       getmaxx, getmaxy, getparx, and getpary  for  compatibility  with  older
+       versions of curses; see curs_legacy(3x).
 
-       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).
+       Although X/Open Curses does not address the issue, many implementations
+       expose members of the WINDOW structure containing values  corresponding
+       to   these   macros.    Do   not   rely  on  their  availability;  some
+       implementations make WINDOW opaque (that is, they do not  allow  direct
+       access to 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
-       implementations.   The  difference  is  hidden  by  means  of the macro
-       getmaxyx.
+       members  may  not  have  values   of   the   same   meaning   different
+       implementations.    For   example,   the  values  of  WINDOW._maxx  and
+       WINDOW._maxy in ncurses have long  differed  by  one  from  some  other
+       implementations.  The getmaxyx macro hides this difference.

SEE ALSO

@@ -109,7 +109,7 @@
 
 
 
-ncurses 6.4                       2023-09-23                    curs_getyx(3x)
+ncurses 6.5                       2024-05-11                    curs_getyx(3x)