X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inch.3x.html;h=6b37318c597e41531b0ecc332e4d279836edaf55;hp=00e08683d7f2166eafdf192fd7cff8c12e4ef316;hb=HEAD;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012 diff --git a/doc/html/man/curs_inch.3x.html b/doc/html/man/curs_inch.3x.html index 00e08683..15bd134e 100644 --- a/doc/html/man/curs_inch.3x.html +++ b/doc/html/man/curs_inch.3x.html @@ -1,7 +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. +
+ 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. --
- The following bit-masks may be AND-ed with characters - returned by winch. - A_CHARTEXT Bit-mask to extract character - A_ATTRIBUTES Bit-mask to extract attributes - A_COLOR Bit-mask to extract color-pair field information +
+ The following bit masks may be AND-ed with characters returned by + winch. + Name Description + ------------------------------------------------------------------------ + A_CHARTEXT Extract character + A_ATTRIBUTES Extract attributes + A_COLOR Extract color pair information --
- Functions with a "mv" prefix first perform a cursor move- - ment using wmove, and return an error if the position is - outside the window, or if the window pointer is null. +
+ Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. --
+ The winch function does not return an error if the window contains + characters larger than 8-bits (255). Only the low-order 8 bits of the + character are used by winch. + + +
Note that all of these routines may be macros. --
- These functions are described in the XSI Curses standard, - Issue 4. +
+ These functions are described in X/Open Curses, Issue 4. + Very old systems (before standardization) provide a different function + with the same name: --
- curses(3x). + o The winch function was part of the original BSD curses library, + which stored a 7-bit character combined with the standout + attribute. + + In BSD curses, winch returned only the character (as an integer) + with the standout attribute removed. + + o System V curses added support for several video attributes which + could be combined with characters in the window. + + Reflecting this improvement, the function was altered to return the + character combined with all video attributes in a chtype value. + + X/Open Curses does not specify the size and layout of attributes, color + and character values in chtype; it is implementation-dependent. This + implementation uses 8 bits for character values. An application using + more bits, e.g., a Unicode value, should use the wide-character + equivalents to these functions. + + +
+ curs_in_wch(3x) describes comparable functions of the ncurses library + in its wide-character configuration (ncursesw). - Comparable functions in the wide-character (ncursesw) - library are described in curs_in_wch(3x). + curses(3x), curs_instr(3x) - curs_inch(3x) +ncurses 6.5 2024-04-20 curs_inch(3x)