X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_legacy.3x.html;h=24071db7fb76abfd3a5235e3aac4da27f44f7510;hp=f06602e997f64a0885e2e881c81b4dd5a07afe30;hb=47d2fb4537d9ad5bb14f4810561a327930ca4280;hpb=cef50b3afcd58166f3541b701c97bce538844c76;ds=sidebyside diff --git a/doc/html/man/curs_legacy.3x.html b/doc/html/man/curs_legacy.3x.html index f06602e9..24071db7 100644 --- a/doc/html/man/curs_legacy.3x.html +++ b/doc/html/man/curs_legacy.3x.html @@ -1,7 +1,7 @@ - +
+ +- -curs_legacy(3x) curs_legacy(3x) +curs_legacy(3x) curs_legacy(3x) --
- getattrs - 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 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. --
- These functions return an integer, or ERR if the window - parameter is null. + o The getcury and getcurx functions return the same data as getyx. + o The getmaxy and getmaxx functions return the same data as getmaxyx. --
- 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. + o The getpary and getparx functions return the same data as getparyx. --
- These functions were supported on Version 7, BSD or System - V implementations. +
+ Except as noted, these functions return an integer, or ERR if the win- + dow 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. + + +
+ These functions were supported on Version 7, BSD or System V implemen- + 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. + + +
curses(3x), curs_getyx(3x), curs_opaque(3x) - curs_legacy(3x) + curs_legacy(3x)-