diff options
Diffstat (limited to 'man/curs_bkgrnd.3x')
| -rw-r--r-- | man/curs_bkgrnd.3x | 38 |
1 files changed, 29 insertions, 9 deletions
diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 08ea59f10217..78ee92e18e32 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2010,2012 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2017,2018 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.5 2012/11/03 23:03:59 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.10 2018/12/09 00:50:50 tom Exp $ +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .TH curs_bkgrnd 3X "" .SH NAME \fBbkgrnd\fR, @@ -52,12 +56,15 @@ \fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR .br .SH DESCRIPTION +.SS bkgrndset +.PP The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the background of the named window. The window background is a \fBcchar_t\fR consisting of any combination of attributes (i.e., rendition) and a complex character. The attribute part of the background is combined (OR'ed) with all non-blank -characters that are written into the window with \fBwaddch\fR. Both +characters that are written into the window with \fBwaddch\fR. +Both the character and attribute parts of the background are combined with the blank characters. The background becomes a property of the @@ -67,34 +74,47 @@ insert/delete line/character operations. To the extent possible on a particular terminal, the attribute part of the background is displayed as the graphic rendition of the character put on the screen. +.SS bkgrnd .PP The \fBbkgrnd\fR and \fBwbkgrnd\fR functions set the background property of the current or specified window and then apply this setting to every character position in that window: -.RS -.PP +.bP The rendition of every character on the screen is changed to the new background rendition. -.PP +.bP Wherever the former background character appears, it is changed to the new background character. -.RE +.SS getbkgrnd .PP The \fBgetbkgrnd\fR function returns the given window's current background character/attribute pair via the \fBwch\fR pointer. -. +If the given window pointer is null, +the character is not updated (but no error returned). .SH NOTES Note that \fBbkgrnd\fR, \fBbkgrndset\fR, and \fBgetbkgrnd\fR may be macros. +.PP +X/Open Curses does not provide details on how the rendition is changed. +This implementation follows the approach used in SVr4 curses, +which is explained in the manual page for \fBwbkgd\fP. .SH RETURN VALUE +.PP The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value. .PP Upon successful completion, the other functions return \fBOK\fR. -Otherwise, they return \fBERR\fR. +Otherwise, they return \fBERR\fR: +.bP A null window pointer is treated as an error. +.bP +A null character pointer is treated as an error. +.SH PORTABILITY +.PP +These functions are described in the XSI Curses standard, Issue 4 +(X/Open Curses). .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_bkgd\fR(3X) |