mirror of
https://github.com/freebsd/freebsd-src.git
synced 2024-12-04 16:49:40 +00:00
114 lines
4.3 KiB
Groff
114 lines
4.3 KiB
Groff
|
.TH curs_addch 3X ""
|
||
|
|
.SH NAME
|
||
|
|
\fBcurs_addch\fR: \fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR,
|
||
|
|
\fBechochar\fR, \fBwechochar\fR - add a character (with attributes) to a
|
||
|
|
\fBncurses\fR window, then advance the cursor
|
||
|
|
.SH SYNOPSIS
|
||
|
|
\fB#include <ncurses.h>\fR
|
||
|
|
|
||
|
|
\fBaddch(chtype ch);\fR
|
||
|
|
.br
|
||
|
|
\fBwaddch(WINDOW *win, chtype ch);\fR
|
||
|
|
.br
|
||
|
|
\fBmvaddch(int y, int x, chtype ch);\fR
|
||
|
|
.br
|
||
|
|
\fBmvwaddch(WINDOW *win, int y, int x, chtype ch);\fR
|
||
|
|
.br
|
||
|
|
\fBechochar(chtype ch);\fR
|
||
|
|
.br
|
||
|
|
\fBwechochar(WINDOW *win, chtype ch);\fR
|
||
|
|
.br
|
||
|
|
.SH DESCRIPTION
|
||
|
|
The \fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR and \fBmvwaddch\fR routines put
|
||
|
|
the character \fIch\fR into the given window at its current window position,
|
||
|
|
which is then advanced. They are analogous to \fBputchar\fR in \fBstdio\fR(3).
|
||
|
|
If the advance is at the right margin, the cursor automatically wraps to the
|
||
|
|
beginning of the next line. At the bottom of the scrolling region, if
|
||
|
|
\fBscrollok\fR is enabled, the scrolling region is scrolled up one line.
|
||
|
|
|
||
|
|
If \fIch\fR is a tab, newline, or backspace, the cursor is moved appropriately
|
||
|
|
within the window. A newline also does a \fBclrtoeol\fR before moving. Tabs
|
||
|
|
are considered to be at every eighth column.
|
||
|
|
|
||
|
|
If \fIch\fR is any control character other than tab, newline, or backspace, it
|
||
|
|
is drawn in \fB^\fR\fIX\fR notation. Calling \fBwinch\fR after adding a
|
||
|
|
control character does not return the control character, but instead returns
|
||
|
|
the representation of the control character. (To emit control characters
|
||
|
|
literally, use \fBechochar\fR.)
|
||
|
|
|
||
|
|
Video attributes can be combined with a character by OR-ing them into the
|
||
|
|
parameter. This results in these attributes also being set. (The intent here
|
||
|
|
is that text, including attributes, can be copied from one place to another
|
||
|
|
using \fBinch\fR and \fBaddch\fR.) [see \fBstandout\fR, predefined video
|
||
|
|
attribute constants, on the curs_attr(3X) page].
|
||
|
|
|
||
|
|
The \fBechochar\fR and \fBwechochar\fR routines are functionally equivalent to
|
||
|
|
a call to \fBaddch\fR followed by a call to \fBrefresh\fR, or a call to
|
||
|
|
\fBwaddch\fR followed by a call to \fBwrefresh\fR. The knowledge that only a
|
||
|
|
single character 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.
|
||
|
|
.SS Line Graphics
|
||
|
|
The following variables may be used to add line drawing characters to the
|
||
|
|
screen with routines of the \fBaddch\fR family. The default character listed
|
||
|
|
below is used if the \fBacsc\fR capability doesn't define a terminal-specific
|
||
|
|
replacement for it. The names are taken from the the VT100 nomenclature.
|
||
|
|
|
||
|
|
.TS
|
||
|
|
l l l
|
||
|
|
_ _ _
|
||
|
|
l l l.
|
||
|
|
\fIName\fR \fIDefault\fR \fIDescription\fR
|
||
|
|
ACS_ULCORNER + upper left-hand corner
|
||
|
|
ACS_LLCORNER + lower left-hand corner
|
||
|
|
ACS_URCORNER + upper right-hand corner
|
||
|
|
ACS_LRCORNER + lower right-hand corner
|
||
|
|
ACS_RTEE + right tee
|
||
|
|
ACS_LTEE + left tee
|
||
|
|
ACS_BTEE + bottom tee
|
||
|
|
ACS_TTEE + top tee
|
||
|
|
ACS_HLINE - horizontal line
|
||
|
|
ACS_VLINE | vertical line
|
||
|
|
ACS_PLUS + plus
|
||
|
|
ACS_S1 - scan line 1
|
||
|
|
ACS_S9 \&_ scan line 9
|
||
|
|
ACS_DIAMOND + diamond
|
||
|
|
ACS_CKBOARD : checker board (stipple)
|
||
|
|
ACS_DEGREE ' degree symbol
|
||
|
|
ACS_PLMINUS # plus/minus
|
||
|
|
ACS_BULLET o bullet
|
||
|
|
ACS_LARROW < arrow pointing left
|
||
|
|
ACS_RARROW > arrow pointing right
|
||
|
|
ACS_DARROW v arrow pointing down
|
||
|
|
ACS_UARROW ^ arrow pointing up
|
||
|
|
ACS_BOARD # board of squares
|
||
|
|
ACS_LANTERN # lantern symbol
|
||
|
|
ACS_BLOCK # solid square block
|
||
|
|
.TE
|
||
|
|
|
||
|
|
.SH RETURN VALUE
|
||
|
|
All routines return the integer \fBERR\fR upon failure and an integer value
|
||
|
|
other than \fBERR\fR upon successful completion, unless otherwise noted in the
|
||
|
|
preceding routine descriptions.
|
||
|
|
.SH BUGS
|
||
|
|
The ncurses implementation does not yet handle insertion of a character at the
|
||
|
|
bottom-rightmost position of the screen correctly. If the terminal has the
|
||
|
|
auto_right_margin property, the real screen will be scrolled up one regardless
|
||
|
|
of whether scrollok has been enabled for \fBstdscr\fR.
|
||
|
|
|
||
|
|
The entry points \fBechochar\fR and \fBwechochar\fR are not yet implemented in
|
||
|
|
ncurses 1.8.1.
|
||
|
|
.SH NOTES
|
||
|
|
Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and
|
||
|
|
\fBechochar\fR may be macros.
|
||
|
|
.SH SEE ALSO
|
||
|
|
\fBncurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_clear\fR(3X),
|
||
|
|
\fBcurs_inch\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X),
|
||
|
|
\fBputc\fR(3S).
|
||
|
|
.\"#
|
||
|
|
.\"# The following sets edit modes for GNU EMACS
|
||
|
|
.\"# Local Variables:
|
||
|
|
.\"# mode:nroff
|
||
|
|
.\"# fill-column:79
|
||
|
|
.\"# End:
|