Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
curs_getyx(3X)							curs_getyx(3X)

NAME
       getyx,  getparyx, getbegyx, getmaxyx - get curses cursor	and window co-
       ordinates

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.

       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.

       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 getbegx, getbegy, getcurx, getcury,
       getmaxx,	getmaxy, getparx and getpary for compatibility with older ver-
       sions of	curses.	 X/Open	does not define	a corresponding	getcuryx func-
       tion, though that would be needed to  make  references  to  the	WINDOW
       structure opaque.

SEE ALSO
       curses(3X)

								curs_getyx(3X)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=getyx&sektion=3x&manpath=FreeBSD+7.0-RELEASE>

home | help