1curs_add_wch(3X) curs_add_wch(3X)
2
6 add_wch, wadd_wch, mvadd_wch, mvwadd_wch, echo_wchar, wecho_wchar - add
7 a complex character and rendition to a curses window, then advance the
8 cursor
9
11 #include <curses.h>
12 int add_wch( const cchar_t *wch );
14 int wadd_wch( WINDOW *win, const cchar_t *wch );
15 int mvadd_wch( int y, int x, const cchar_t *wch );
16 int mvwadd_wch( WINDOW *win, int y, int x, const cchar_t *wch );
17 int echo_wchar( const cchar_t *wch );
18 int wecho_wchar( WINDOW *win, const cchar_t *wch );
19
21 The add_wch, wadd_wch, mvadd_wch, and mvwadd_wch functions put the com‐
22 plex character wch into the given window at its current position, which
23 is then advanced. These functions perform wrapping and special-charac‐
24 ter processing as follows:
25 · If wch refers to a spacing character, then any previous character
27 at that location is removed. A new character specified by wch is
28 placed at that location with rendition specified by wch. The cur‐
29 sor then advances to the next spacing character on the screen.
30 · If wch refers to a non-spacing character, all previous characters
32 at that location are preserved. The non-spacing characters of wch
33 are added to the spacing complex character, and the rendition spec‐
34 ified by wch is ignored.
35 · If the character part of wch is a tab, newline, backspace or other
37 control character, the window is updated and the cursor moves as if
38 addch were called.
39 The echo_wchar function is functionally equivalent to a call to add_wch
41 followed by a call to refresh. Similarly, the wecho_wchar is function‐
42 ally equivalent to a call to wadd_wch followed by a call to wrefresh.
43 The knowledge that only a single character is being output is taken
44 into consideration and, for non-control characters, a considerable per‐
45 formance gain might be seen by using the *echo* functions instead of
46 their equivalents.
47 Line Graphics
49 Like addch(3X), addch_wch accepts symbols which make it simple to draw
50 lines and other frequently used special characters. These symbols cor‐
51 respond to the same VT100 line-drawing set as addch(3X).
52 Name Unicode Default Description
54 ────────────────────────────────────────────────────────────────
55 WACS_BLOCK 0x25ae # solid square block
56 WACS_BOARD 0x2592 # board of squares
57 WACS_BTEE 0x2534 + bottom tee
58 WACS_BULLET 0x00b7 o bullet
59 WACS_CKBOARD 0x2592 : checker board (stipple)
60 WACS_DARROW 0x2193 v arrow pointing down
61 WACS_DEGREE 0x00b0 ' degree symbol
62 WACS_DIAMOND 0x25c6 + diamond
63 WACS_GEQUAL 0x2265 > greater-than-or-equal-to
64 WACS_HLINE 0x2500 - horizontal line
65 WACS_LANTERN 0x2603 # lantern symbol
66 WACS_LARROW 0x2190 < arrow pointing left
68 WACS_LEQUAL 0x2264 < less-than-or-equal-to
69 WACS_LLCORNER 0x2514 + lower left-hand corner
70 WACS_LRCORNER 0x2518 + lower right-hand corner
71 WACS_LTEE 0x2524 + left tee
72 WACS_NEQUAL 0x2260 ! not-equal
73 WACS_PI 0x03c0 * greek pi
74 WACS_PLMINUS 0x00b1 # plus/minus
75 WACS_PLUS 0x253c + plus
76 WACS_RARROW 0x2192 > arrow pointing right
77 WACS_RTEE 0x251c + right tee
78 WACS_S1 0x23ba - scan line 1
79 WACS_S3 0x23bb - scan line 3
80 WACS_S7 0x23bc - scan line 7
81 WACS_S9 0x23bd _ scan line 9
82 WACS_STERLING 0x00a3 f pound-sterling symbol
83 WACS_TTEE 0x252c + top tee
84 WACS_UARROW 0x2191 ^ arrow pointing up
85 WACS_ULCORNER 0x250c + upper left-hand corner
86 WACS_URCORNER 0x2510 + upper right-hand corner
87 WACS_VLINE 0x2502 | vertical line
88 The wide-character configuration of ncurses also defines symbols for
90 thick- and double-lines:
91 Name Unicode Default Description
93 ─────────────────────────────────────────────────────────────────────
94 WACS_T_ULCORNER 0x250f + thick upper left corner
95 WACS_T_LLCORNER 0x2517 + thick lower left corner
96 WACS_T_URCORNER 0x2513 + thick upper right corner
97 WACS_T_LRCORNER 0x251b + thick lower right corner
98 WACS_T_LTEE 0x252b + thick tee pointing right
99 WACS_T_RTEE 0x2523 + thick tee pointing left
100 WACS_T_BTEE 0x253b + thick tee pointing up
101 WACS_T_TTEE 0x2533 + thick tee pointing down
102 WACS_T_HLINE 0x2501 - thick horizontal line
103 WACS_T_VLINE 0x2503 | thick vertical line
104 WACS_T_PLUS 0x254b + thick large plus or crossover
105 WACS_D_ULCORNER 0x2554 + double upper left corner
106 WACS_D_LLCORNER 0x255a + double lower left corner
107 WACS_D_URCORNER 0x2557 + double upper right corner
108 WACS_D_LRCORNER 0x255d + double lower right corner
109 WACS_D_RTEE 0x2563 + double tee pointing left
110 WACS_D_LTEE 0x2560 + double tee pointing right
111 WACS_D_BTEE 0x2569 + double tee pointing up
112 WACS_D_TTEE 0x2566 + double tee pointing down
113 WACS_D_HLINE 0x2550 - double horizontal line
114 WACS_D_VLINE 0x2551 | double vertical line
115 WACS_D_PLUS 0x256c + double large plus or crossover
116
118 All routines return the integer ERR upon failure and OK on success.
119 Functions with a "mv" prefix first perform a cursor movement using
121 wmove, and return an error if the position is outside the window, or if
122 the window pointer is null.
123
125 Note that add_wch, mvadd_wch, mvwadd_wch, and echo_wchar may be macros.
126
128 All of these functions are described in the XSI Curses standard, Issue
129 4. The defaults specified for line-drawing characters apply in the
130 POSIX locale.
131 X/Open Curses makes it clear that the WACS_ symbols should be defined
133 as a pointer to cchar_t data, e.g., in the discussion of border_set. A
134 few implementations are problematic:
135 · NetBSD curses defines the symbols as a wchar_t within a cchar_t.
137 · HPUX curses equates some of the ACS_ symbols to the analogous WACS_
139 symbols as if the ACS_ symbols were wide characters. The misde‐
140 fined symbols are the arrows and other symbols which are not used
141 for line-drawing.
142 X/Open Curses does not define symbols for thick- or double-lines. SVr4
144 curses implementations defined their line-drawing symbols in terms of
145 intermediate symbols. This implementation extends those symbols, pro‐
146 viding new definitions which are not in the SVr4 implementations.
147
149 curses(3X), curs_addch(3X), curs_attr(3X), curs_clear(3X), curs_out‐
150 opts(3X), curs_refresh(3X), putwc(3)
151 curs_add_wch(3X)