X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_inch.3x.html;h=0c5295818336eb30bfbe20d0805de143896c4477;hb=HEAD;hp=8db494d2f4a82b3ed51c38561156e6bec73b7178;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html index 8db494d2..3dfd504e 100644 --- a/doc/html/man/curs_inch.3x.html +++ b/doc/html/man/curs_inch.3x.html @@ -1,8 +1,8 @@ - - +
-- -curs_inch(3x) curs_inch(3x) +curs_inch(3x) Library calls curs_inch(3x) --
- inch, winch, mvinch, mvwinch - get a character and - attributes from a curses window +
+ inch, winch, mvinch, mvwinch - get a curses character from a window --
+
#include <curses.h> chtype inch(void); - chtype winch(WINDOW *win); - chtype mvinch(int y, int x); - chtype mvwinch(WINDOW *win, int y, int x); + chtype winch(WINDOW * win); + chtype mvinch(int y, int x); + chtype mvwinch(WINDOW * win, int y, int x); --
- These routines return the character, of type chtype, at - the current position in the named window. If any - attributes are set for that position, their values are - OR'ed into the value returned. Constants defined in - <curses.h> can be used with the & (logical AND) operator - to extract the character or attributes alone. +
+ winch returns the curses character, including its attributes and color + pair identifier, at the cursor position in the window win. Subsection + "Video Attributes" of attron(3x) explains how to extract these data + from a chtype. ncurses(3x) describes the variants of this function. - Attributes - The following bit-masks may be AND-ed with characters - returned by winch. +
+ These functions return OK on success and ERR on failure. + In ncurses, winch returns ERR if win is NULL. - A_CHARTEXT Bit-mask to extract character - A_ATTRIBUTES Bit-mask to extract attributes - A_COLOR Bit-mask to extract color-pair field information + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. --
- Note that all of these routines may be macros. +
+ inch, mvinch, and mvwinch may be implemented as macros. + These functions do not fail if the window contains cells of curses + complex characters; that is, if they contain characters with codes + wider than eight bits (or greater than 255 as an unsigned decimal + integer). They instead extract only the low-order eight bits of the + character code from the cell. --
- These functions are described in the XSI Curses standard, - Issue 4. +
+ X/Open Curses, Issue 4 describes these functions. It specifies no + error conditions for them. --
- curses(3x). + +
+ The original curses in 4BSD (1980) defined winch as a macro accessing + the WINDOW structure member representing character cell data, at that + time a char, containing only a 7-bit ASCII character code and a + "standout" attribute bit, the only one the library supported. + + SVr2 curses (1984) extended this approach, widening the character code + to eight bits and permitting several attributes to be combined with it + by storing them together in a chtype, an alias of unsigned short. + Because a macro was used, its value was not type-checked as a function + return value could have been. Goodheart documented SVr3 (1987) winch + as returning an int. SVr3.1's (1987) chtype became an alias of + unsigned long, using 16 bits for the character code and widening the + type in practical terms to 32 bits, as 64-bit Unix systems were not yet + in wide use, and fixed-width integral types would not be standard until + ISO C99. SVr3.2 (1988) added a 6-bit color pair identifier alongside + the attributes. + + X/Open Curses does not specify the sizes of the character code or color + pair identifier, nor the quantity of attribute bits, in chtype; these + are implementation-dependent. ncurses uses eight bits for the + character code. An application requiring a wider character type, for + instance to represent Unicode, should use the wide-character + counterparts of these functions. + + +
+ curs_in_wch(3x) describes comparable functions of the ncurses library + in its wide-character configuration (ncursesw). + + curses(3x), curs_instr(3x) - curs_inch(3x) +ncurses 6.5 2024-06-01 curs_inch(3x)-