X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=181060cb5865fd89a34bd5e8a41d3865a4e14138;hb=f6b436c4fb50275df43ea10ba9c744fe195a327d;hp=991037b3343464a2dede9ba33c3b66fd33a7d97f;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d;p=ncurses.git diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 991037b3..181060cb 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) curs_legacy(3x)
- curs_legacy - get curses cursor and window coordinates, - attributes + curs_legacy - get curses cursor and window coordinates, attributes
#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 func- - tions. 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 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.
- These functions were supported on Version 7, BSD or System - V implementations. + 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.
@@ -103,7 +123,7 @@ - curs_legacy(3x) + curs_legacy(3x)