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=d6db1a8bc745af8e763802c46472a1fcc5bdee1b;hb=HEAD;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_getyx.3x.html b/doc/html/man/curs_getyx.3x.html index d6db1a8b..fa30badb 100644 --- a/doc/html/man/curs_getyx.3x.html +++ b/doc/html/man/curs_getyx.3x.html @@ -1,7 +1,7 @@ - - + -curs_getyx 3x - - + + +curs_getyx 3x 2024-05-11 ncurses 6.5 Library calls + + -

curs_getyx 3x

-
+

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

-
-
-
-

NAME

-       getyx,  getparyx,  getbegyx,  getmaxyx - get curses cursor
-       and window coordinates
+curs_getyx(3x)                   Library calls                  curs_getyx(3x)
 
 
-
-

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);
 
 
-
-

DESCRIPTION

-       The getyx macro places the current cursor position of  the
-       given window in the two integer variables y and x.
+

NAME

+       getyx,  getparyx,  getbegyx,  getmaxyx  -  get curses cursor and window
+       coordinates
 
-       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.
+

SYNOPSIS

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

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).
+       void getparyx(WINDOW *win, int y, int x);
 
 
-
-

NOTES

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

DESCRIPTION

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

PORTABILITY

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

RETURN VALUE

+       No return values are defined for macros.  Do not use them as the right-
+       hand side of assignment statements.
 
 
-
-

SEE ALSO

-       curses(3x)
+

NOTES

+       All of these interfaces are implemented as macros.  An "&" operator  is
+       not necessary before the variables y and x.
 
 
+

PORTABILITY

+       These macros are described in X/Open Curses, Issue 4.
 
+       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 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  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

+       curses(3x), curs_legacy(3x), curs_opaque(3x)
 
 
 
+ncurses 6.5                       2024-05-11                    curs_getyx(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +