X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addch.3x.html;h=80ed97c81a881e3179157be03466ce907be6d638;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hp=04b15afed5727c258561f0162db1d8cb0472a866;hpb=32f9f5f12cd9159261f9db228461049e8c770404;p=ncurses.git diff --git a/doc/html/man/curs_addch.3x.html b/doc/html/man/curs_addch.3x.html index 04b15afe..80ed97c8 100644 --- a/doc/html/man/curs_addch.3x.html +++ b/doc/html/man/curs_addch.3x.html @@ -1,7 +1,7 @@ @@ -46,15 +46,13 @@ - -
+
addch, waddch, mvaddch, mvwaddch, echochar, wechochar - add a character (with attributes) to a curses window, then advance the cursor --
+
#include <curses.h> int addch(const chtype ch); @@ -65,16 +63,14 @@ int wechochar(WINDOW *win, const chtype ch); --
+
--
+
The addch, waddch, mvaddch and mvwaddch routines put the character ch into the given window at its current window position, which is then advanced. They are analogous to - putchar in stdio(3). If the advance is at the right mar- - gin: + putchar(3) in stdio(3). If the advance is at the right + margin: o The cursor automatically wraps to the beginning of the next line. @@ -113,31 +109,32 @@ Video attributes can be combined with a character argument passed to addch or related functions by logical-ORing them into the character. (Thus, text, including attributes, - can be copied from one place to another using inch and + can be copied from one place to another using inch(3x) and addch.) See the curs_attr(3x) page for values of prede- fined video attribute constants that can be usefully OR'ed into characters. --
+
The echochar and wechochar routines are equivalent to a - call to addch followed by a call to refresh, or a call to - waddch followed by a call to wrefresh. The knowledge that - only a single character is being output is used and, for - non-control characters, a considerable performance gain - may be seen by using these routines instead of their + call to addch followed by a call to refresh(3x), or a call + to waddch followed by a call to wrefresh. The knowledge + that only a single character is being output is used and, + for non-control characters, a considerable performance + gain may be seen by using these routines instead of their equivalents. --
+
The following variables may be used to add line drawing characters to the screen with routines of the addch fam- ily. The default character listed below is used if the acsc capability does not define a terminal-specific - replacement for it. The names are taken from VT100 nomen- - clature. + replacement for it, or if the terminal and locale configu- + ration requires Unicode but the library is unable to use + Unicode. + + The names are taken from VT100 nomenclature. Name Default Description -------------------------------------------------- @@ -175,44 +172,54 @@ ACS_VLINE | vertical line --
+
All routines return the integer ERR upon failure and OK on - success (the SVr4 manuals specify only "an integer value + success (the SVr4 manuals specify only "an integer value other than ERR") upon successful completion, unless other- wise noted in the preceding routine descriptions. - Functions with a "mv" prefix first perform a cursor move- - ment using wmove, and return an error if the position is + 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. --
- Note that addch, mvaddch, mvwaddch, and echochar may be +
+ Note that addch, mvaddch, mvwaddch, and echochar may be macros. --
- All these functions are described in the XSI Curses stan- - dard, Issue 4. The defaults specified for forms-drawing +
+ All these functions are described in the XSI Curses stan- + dard, Issue 4. The defaults specified for forms-drawing characters apply in the POSIX locale. - X/Open Curses states that the ACS_ definitions are char - constants. For the wide-character implementation (see + X/Open Curses states that the ACS_ definitions are char + constants. For the wide-character implementation (see curs_add_wch), there are analogous WACS_ definitions which are cchar_t constants. - Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL, ACS_GEQUAL, - ACS_PI, ACS_NEQUAL, ACS_STERLING) were not documented in - any publicly released System V. However, many publicly - available terminfos include acsc strings in which their - key characters (pryz{|}) are embedded, and a second-hand - list of their character descriptions has come to light. - The ACS-prefixed names for them were invented for + Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL, ACS_GEQUAL, + ACS_PI, ACS_NEQUAL, ACS_STERLING) were not documented in + any publicly released System V. However, many publicly + available terminfos include acsc strings in which their + key characters (pryz{|}) are embedded, and a second-hand + list of their character descriptions has come to light. + The ACS-prefixed names for them were invented for ncurses(3x). + The displayed values for the ACS_ and WACS_ constants + depend on + + o the library configuration, i.e., ncurses versus ncurs- + esw, where the latter is capable of displaying Unicode + while the former is not, and + + o whether the locale uses UTF-8 encoding. + + In certain cases, the terminal is unable to display line- + drawing characters except by using UTF-8 (see the discus- + sion of NCURSES_NO_UTF8_ACS in ncurses(3x)). + The TABSIZE variable is implemented in some versions of curses, but is not part of X/Open curses. @@ -221,8 +228,7 @@ of other implementations, but is not documented. --
+
curses(3x), curs_attr(3x), curs_clear(3x), curs_inch(3x), curs_outopts(3x), curs_refresh(3x), curs_variables(3x), putc(3).