X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=1fea49098c6006e09fbc896ec12d20cd8fbe77bb;hp=66a9f4b242b1c6754e41799efcf9c6d5f5d42d74;hb=9193d076200365eeb5ff932acdbbdcc5e452292c;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index 66a9f4b2..1fea4909 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,6 +1,6 @@
- +#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 func- + tions: - The getcury and getcurx functions return the same data as getyx. + o The getattrs function returns the same attribute data as wattr_get. - The getmaxy and getmaxx functions return the same data as getmaxyx. + 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 getpary and getparx functions return the same data as getparyx. + 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). + + 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 win- + dow parameter is null.
@@ -89,7 +105,11 @@
These functions were supported on Version 7, BSD or System V implemen- - tations. + tations. None of those implementations checked the window parameter. + + The getattrs function and macro are defined to return a (signed) inte- + ger for compatibility with those implementations although an unsigned + type would have been more appropriate.