Current File : //usr/share/man/man3xcurses/add_wch.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH add_wch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
add_wch, mvadd_wch, mvwadd_wch, wadd_wch \- add a complex character (with   rendition) to a window
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ]

#include <curses.h>

\fBint\fR \fBadd_wch\fR(\fBconst cchar_t *\fR\fIwch\fR);
.fi

.LP
.nf
\fBint\fR \fBwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR);
.fi

.LP
.nf
\fBint\fR \fBmvadd_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
.fi

.LP
.nf
\fBint\fR \fBmvwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBadd_wch()\fR function writes a complex character to the \fBstdscr\fR window at the current cursor position.  The \fBmvadd_wch()\fR and \fBmvwadd_wch()\fR functions write the character  to the position indicated by the \fIx\fR (column) and \fIy\fR (row) parameters. The \fBmvadd_wch()\fR function writes the character to the \fBstdscr\fR window, while \fBmvwadd_wch()\fR writes the character to the window specified  by \fIwin\fR.  The \fBwadd_wch()\fR function is identical to \fBadd_wch()\fR, but writes the  character to the window specified by \fIwin\fR.  These functions advance the cursor after writing the character.
.sp
.LP
If \fIwch\fR is a spacing complex character, X/Open Curses replaces any previous  character at the specified location with \fIwch\fR (and its rendition). If \fIwch\fR is a non-spacing complex character, X/Open Curses preserves all existing characters at the specified location and adds the non-spacing  characters of \fIwch\fR to the spacing complex character. It ignores the  rendition associated with \fIwch\fR.
.sp
.LP
Characters that do not fit on the end of the current line are wrapped to the beginning of the next line unless the current line is the last line of the window and scrolling is disabled. In that situation, X/Open Curses discards characters which extend beyond the end  of the line.
.sp
.LP
When \fIwch\fR is a backspace, carriage return, newline, or tab, X/Open Curses moves the cursor appropriately as described in the \fBcurses\fR(3XCURSES) man page. Each tab character moves the cursor to the next tab stop. By default, tab stops occur every eight columns. When \fIwch\fR is a control character other than a backspace, carriage return, newline, or tab, it is written using \fB^\fR\fIx\fR notation, where \fIx\fR is a printable character. When X/Open Curses writes \fIwch\fR to the last character position on a line, it automatically generates a newline. When \fI wch\fR is written to the last character position of a scrolling region and \fBscrollok()\fR is enabled, X/Open Curses scrolls the scrolling region up one line (see \fBclearok\fR(3XCURSES)).
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwch\fR\fR
.ad
.RS 7n
.rt  
Is the character/attribute pair (rendition) to be written to the window.
.RE

.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to the window in which the character is to be written.
.RE

.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 7n
.rt  
Is the y (row) coordinate of the character's position in the window.
.RE

.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 7n
.rt  
Is the x (column) coordinate of the character's position in the window.
.RE

.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBattr_off\fR(3XCURSES), \fBbkgrndset\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBin_wch\fR(3XCURSES), \fBins_wch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnl\fR(3XCURSES), \fBprintw\fR(3XCURSES), \fBscrollok\fR(3XCURSES), \fBscrl\fR(3XCURSES), \fBsetscrreg\fR(3XCURSES), \fBterminfo\fR(4), \fBattributes\fR(5), \fBstandards\fR(5)