X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=d3fadc3a57ee1e9874065f632508b8e33bec2c8a;hp=66a9f4b242b1c6754e41799efcf9c6d5f5d42d74;hb=HEAD;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 66a9f4b2..22f78ddd 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,6 +1,7 @@ -
- --curs_legacy(3x) curs_legacy(3x) +curs_legacy(3x) Library calls curs_legacy(3x)
- curs_legacy - get curses cursor and window coordinates, attributes + getattrs, getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, + getparx, getpary - get curses cursor and window coordinates or + attributes (legacy)
#include <curses.h> - int getattrs(WINDOW *win); - int getbegx(WINDOW *win); - int getbegy(WINDOW *win); - int getcurx(WINDOW *win); - int getcury(WINDOW *win); - int getmaxx(WINDOW *win); - int getmaxy(WINDOW *win); - int getparx(WINDOW *win); - int getpary(WINDOW *win); + 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);
- The getbegy and getbegx functions return the same data as getbegyx. + These legacy functions are simpler to use than the X/Open curses + functions: + + o The getattrs function returns the same attribute data as wattr_get. - The getcury and getcurx functions return the same data as getyx. + However, getattrs returns an integer (actually a chtype), while + wattr_get returns the current color pair in a separate parameter. + In the wide-character library configuration, color pairs may not + fit into a chtype, so wattr_get is the only way to obtain the color + information. - The getmaxy and getmaxx functions return the same data as getmaxyx. + Because getattrs returns the attributes in a single parameter, it + would not be possible for an application to distinguish that from + ERR (a -1). If the window parameter is null, getattrs returns + A_NORMAL (zero). - The getpary and getparx functions return the same data as getparyx. + o The getbegy and getbegx functions return the same data as getbegyx. + + o The getcury and getcurx functions return the same data as getyx. + + o The getmaxy and getmaxx functions return the same data as getmaxyx. + + o The getpary and getparx functions return the same data as getparyx.
- These functions return an integer, or ERR if the window parameter is - null. + Except as noted, these functions return an integer, or ERR if the + window parameter is null.
- All of these interfaces are provided as macros and functions. The - macros are suppressed (and only the functions provided) when - NCURSES_OPAQUE is defined. 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. + 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 implemen- - tations. + 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.
@@ -97,7 +127,7 @@ - curs_legacy(3x) +ncurses 6.5 2024-03-16 curs_legacy(3x)