Curses Library Functions cursaddwch(3CURSES)
NAME
cursaddwch, addwch, waddwch, mvaddwch, mvwaddwch,
echowchar, wechowchar - add a wchart character (with attri-
butes) to a curses window and advance cursor
SYNOPSIS
cc [flag]... file... -lcurses [library]...
#include
int addwch(chtype wch);
int waddwch(WINDOW *win, chtype wch);
int mvaddwch(int y, int x, chtype wch);
int mvwaddwch(WINDOW *win, int y, int x, chtype wch);
int echowchar(chtype wch);
int wechowchar(WINDOW *win, chtype wch);
DESCRIPTION
The addwch(),waddwch(),mvaddwch(), and mvwaddwch() routines
put the character wch, holding a wchart character, into
the window at the current cursor position of the window and
advance the position of the window cursor. Their function is
similar to that of putwchar(3C) in the C multibyte library.
At the right margin, an automatic newline is performed. At
the bottom of the scrolling region, if scrollok is enabled,
the scrolling region is scrolled up one line.
If wch is a tab, newline, or backspace, the cursor is moved
appropriately within the window. A newline also does a
clrtoeol(3CURSES) before moving. Tabs are considered to be
at every eighth column. If wch is another control charac-
ter, it is drawn in the ^X notation. Calling
winwch(3CURSES) after adding a control character does not
return the control character, but instead returns the
representation of the control character.
Video attributes can be combined with a wchart character
by OR-ing them into the parameter. This results in these
SunOS 5.11 Last change: 31 Dec 1996 1
Curses Library Functions cursaddwch(3CURSES)
attributes also being set. (The intent here is that text,
including attributes, can be copied from one place to
another using inwch() and addwch().) See
standout(3CURSES), predefined video attribute constants.
The echowchar() and wechowchar() routines are functionally
equivalent to a call to addwch() followed by a call to
refresh(3CURSES), or a call to waddwch() followed by a call
to wrefresh(3CURSES). The knowledge that only a single char-
acter is being output is taken into consideration and, for
non-control characters, a considerable performance gain
might be seen by using these routines instead of their
equivalents.
Line Graphics
The following variables may be used to add line drawing
characters to the screen with routines of the addwch() fam-
ily. When variables are defined for the terminal, the
ALTCHARSET bit is turned on. (See cursattr(3CURSES)).
Otherwise, the default character listed below is stored in
the variable. The names chosen are consistent with the VT100
nomenclature.
SunOS 5.11 Last change: 31 Dec 1996 2
Curses Library Functions cursaddwch(3CURSES)
SunOS 5.11 Last change: 31 Dec 1996 3
Curses Library Functions cursaddwch(3CURSES)
Name Default Glyph Description
ACSULCORNER ] upper left-hand corner
ACSLCORNER ] lower left-hand corner
ACSURCORNER ] upper right-hand corner
ACSLRCORNER ] lower right-hand corner
ACSRTE ] right tee
ACSLTE ] left tee
ACSBTE ] bottom tee
ACSTE ] top tee
ACSHLINE - horizontal line
ACSVLINE vertical line
ACSPLUS ] plus
ACS1 - scan line 1
ACS9 - scan line 9
ACSDIAMOND ] diamond
ACSCKBOARD : checker board (stipple)
ACSDEGRE ' degree symbol
ACSPLMINUS # plus/minus
ACSBULET o bullet
ACSLAROW < arrow pointing left
ACSRAROW > arrow pointing right
ACSDAROW v arrow pointing down
ACSUAROW ^ arrow pointing up
ACSBOARD # board of squares
ACSLANTERN # lantern symbol
ACSBLOCK # solid square block
SunOS 5.11 Last change: 31 Dec 1996 4
Curses Library Functions cursaddwch(3CURSES)
RETURN VALUE
All routines return the integer ER upon failure and an
integer value other than ER upon successful completion,
unless otherwise noted in the preceding routine descrip-
tions.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
MT-Level Unsafe
SEE ALSO
putwchar(3C), clrtoeol(3CURSES), curses(3CURSES),
cursattr(3CURSES), cursinwch(3CURSES),
cursoutopts(3CURSES), refresh(3CURSES), standout(3CURSES),
winwch(3CURSES), wrefresh(3CURSES), attributes(5)
NOTES
The header file automatically includes the header
files , and .
Note that addwch(), mvaddwch(), mvwaddwch(), and
echowchar() may be macros.
None of these routines can use the color attribute in
chtype.
SunOS 5.11 Last change: 31 Dec 1996 5
|