- addch, waddch, mvaddch, mvwaddch, echochar, wechochar -
- add a character (with attributes) to a curses window, then
+ addch, waddch, mvaddch, mvwaddch, echochar, wechochar -
+ add a character (with attributes) to a curses window, then
advance the cursor
- The addch, waddch, mvaddch and mvwaddch routines put the
- character ch into the given window at its current window
+ 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-
+ 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
+ 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
+ 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
+ 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.
+ 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
+ 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
+ acter 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
- into the character. (Thus, text, including attributes,
- can be copied from one place to another using inch and
- addch.). See the curs_attr(3x) page for values of prede-
+ 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
+ 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
+ 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
equivalents.
- LineGraphics
- 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.
+ LineGraphics
+ 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
+ nomenclature.
+
- NameDefaultDescription
+ NameDefaultDescription
--------------------------------------------------
ACS_BLOCK # solid square block
ACS_BOARD # board of squares
@@ -107,78 +152,64 @@
ACS_VLINE | vertical line
-
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-
+ 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
- Note that addch, mvaddch, mvwaddch, and echochar may be
+ Note that addch, mvaddch, mvwaddch, and echochar may be
macros.
PORTABILITY
- 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
+ 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
+ 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).
-
-
-
-
SEE ALSO
- curses(3x), curs_attr(3x), curs_clear(3x), curs_inch(3x),
- curs_outopts(3x), curs_refresh(3x), putc(3S).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ ncurses(3x).
+ 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
+ of other implementations, but is not documented.
+