curs_legacy(3X) | Library calls | curs_legacy(3X) |
getattrs, getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx, getpary - get curses cursor and window coordinates or attributes (legacy)
#include <ncurses/curses.h>
int getattrs(const WINDOW *win);
int getbegx(const WINDOW *win); int getbegy(const WINDOW *win);
int getcurx(const WINDOW *win); int getcury(const WINDOW *win);
int getmaxx(const WINDOW *win); int getmaxy(const WINDOW *win);
int getparx(const WINDOW *win); int getpary(const WINDOW *win);
These legacy functions are simpler to use than the X/Open curses functions:
Except as noted, these functions return an integer, or ERR if the window parameter is null.
All of these interfaces are implemented as macros and functions. The macros are suppressed (and only the functions provided) in an “opaque” ncurses build, which defines the preprocessor symbol NCURSES_OPAQUE. See section “ALTERNATE CONFIGURATIONS” in ncurses(3X).
The standard forms such as getyx must be implemented as macros, and (in this implementation) are defined in terms of the functions described here, to avoid reliance on internal details of the WINDOW structure.
These functions were supported on Version 7, BSD or System V implementations. None of those implementations checked the window parameter.
The getattrs function and macro are defined to return a (signed) integer for compatibility with those implementations although an unsigned type would have been more appropriate.
2024-03-16 | ncurses 6.5 |