'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.TH bkgrnd 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd \- set or get the background character (and rendition) of window using a complex character
.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 \fBbkgrnd\fR(\fBconst cchar_t *\fR\fIwch\fR);
.fi

.LP
.nf
\fBvoid\fR \fBbkgrndset\fR(\fBconst cchar_t *\fR\fIwch\fR);
.fi

.LP
.nf
\fBint\fR \fBgetbkgrnd\fR(\fBcchar_t *\fR\fIwch\fR);
.fi

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

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

.LP
.nf
\fBint\fR \fBwgetbkgrnd\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwch\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions turn off the previous background attributes, logical OR the requested attributes into the window rendition, and set the background property of the current or specified window based on the information in \fIwch\fR.
.sp
.LP
The \fBbkgrnd()\fR and \fBwbkgrnd()\fR functions turn off the previous background attributes, logical OR the requested attributes into the window rendition, and set the background property of the current or specified window and then apply this setting to every character position in that window:
.RS +4
.TP
.ie t \(bu
.el o
The rendition of every character on the screen is changed to the new window rendition.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Wherever the former background character appears, it is changed to the new background character.
.RE
.sp
.LP
If \fIwch\fR refers to a non-spacing complex character for \fBbkgrnd()\fR, \fBbkgrndset()\fR, \fBwbkgrnd()\fR, and \fBwbkgrndset()\fR, then \fIwch\fR is added to the existing spacing complex character that is the background character. If \fIwch\fR refers to a multi-column character, the results are unspecified.
.sp
.LP
The \fBgetbkgrnd()\fR and \fBwgetbkgrnd()\fR functions store, into the area pointed to buy \fIwch\fR, the window's background character and rendition.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwch\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to the complex background character to be set.
.RE

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

.SH RETURN VALUES
.sp
.LP
The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions do not return a value.
.sp
.LP
Upon successful completion, the other functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
No errors are defined.
.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
\fBadd_wch\fR(3XCURSES), \fBadd_wchnstr\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBaddchstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBbkgd\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), \fBerase\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)