X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addch.3x.html;h=39887f41f9e2e72f1e7ae54637c884aa351ff674;hp=d5ce2fe20f2631099ee82b7b4771a0c0a65fa88f;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_addch.3x.html b/doc/html/man/curs_addch.3x.html index d5ce2fe2..39887f41 100644 --- a/doc/html/man/curs_addch.3x.html +++ b/doc/html/man/curs_addch.3x.html @@ -1,8 +1,7 @@ - +
+ +- curs_addch(3x) curs_addch(3x)-
+NAME
addch, waddch, mvaddch, mvwaddch, echochar, wechochar - add a character (with attributes) to a curses window, then advance the cursor-SYNOPSIS
+SYNOPSIS
#include <curses.h> int addch(const chtype ch); @@ -66,30 +66,46 @@-DESCRIPTION
+DESCRIPTION
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, the cursor automatically wraps to the beginning of - the next line. At the bottom of the current scrolling - region, if scrollok is enabled, the scrolling region is - scrolled up one line. - - If ch is a tab, newline, or backspace, the cursor is moved - appropriately within the window. Backspace moves the cur- - sor one character left; at the left edge of a window it - does nothing. Newline does a clrtoeol, then moves the - cursor to the window left margin on the next line, - scrolling the window if on the last line. Tabs are con- - sidered to be at every eighth column. The tab interval - may be altered by setting the TABSIZE variable. - - If ch is any control character other than tab, newline, or - backspace, it is drawn in ^X notation. Calling winch - after adding a control character does not return the char- - acter itself, but instead returns the ^-representation of - the control character. + putchar in stdio(3). If the advance is at the right mar- + gin: + + o The cursor automatically wraps to the beginning of the + next line. + + o At the bottom of the current scrolling region, and if + scrollok is enabled, the scrolling region is scrolled + up one line. + + o If scrollok is not enabled, writing a character at the + lower right margin succeeds. However, an error is + returned because it is not possible to wrap to a new + line + + If ch is a tab, newline, carriage return or backspace, the + cursor is moved appropriately within the window: + + o Backspace moves the cursor one character left; at the + left edge of a window it does nothing. + + o Carriage return moves the cursor to the window left + margin on the current line. + + o Newline does a clrtoeol, then moves the cursor to the + window left margin on the next line, scrolling the + window if on the last line. + + o Tabs are considered to be at every eighth column. The + tab interval may be altered by setting the TABSIZE + variable. + + If ch is any other control character, it is drawn in ^X + notation. Calling winch after adding a control character + does not return the character itself, but instead returns + the ^-representation of the control character. Video attributes can be combined with a character argument passed to addch or related functions by logical-ORing them @@ -107,14 +123,15 @@ may be seen by using these routines instead of their equivalents. - Line Graphics + ++Line Graphics
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 doesn't define a terminal-specific - replacement for it (but see the EXTENSIONS section below). - The names are taken from VT100 nomenclature. - + acsc capability does not define a terminal-specific + replacement for it. The names are taken from VT100 nomen- + clature. Name Default Description -------------------------------------------------- @@ -153,55 +170,78 @@-RETURN VALUE
+RETURN VALUE
All routines return the integer ERR upon failure and OK on 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 + outside the window, or if the window pointer is null. +-NOTES
+NOTES
Note that addch, mvaddch, mvwaddch, and echochar may be macros.-PORTABILITY
+PORTABILITY
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. - 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 + 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 ncurses(3x). - The TABSIZE variable is implemented in some versions of + The TABSIZE variable is implemented in some versions of curses, but is not part of X/Open curses. - If ch is a carriage return, the cursor is moved to the - beginning of the current row of the window. This is true + If ch is a carriage return, the cursor is moved to the + beginning of the current row of the window. This is true of other implementations, but is not documented.-SEE ALSO
- curses(3x), curs_attr(3x), curs_clear(3x), curs_inch(3x), - curs_outopts(3x), curs_refresh(3x), putc(3S). +SEE ALSO
+ curses(3x), curs_attr(3x), curs_clear(3x), curs_inch(3x), + curs_outopts(3x), curs_refresh(3x), curs_variables(3x), + putc(3). + + Comparable functions in the wide-character (ncursesw) + library are described in curs_add_wch(3x). curs_addch(3x)-
- -Man(1) output converted with -man2html - +