X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_bkgrnd.3x;h=974e358480f302dfdf7aedb16476898ef061850c;hb=4c9f63c460cb7134f142aa65f6866c175ed77605;hp=8e3e83680169fecc5df5c7e140fb2387a65663ba;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 8e3e8368..974e3584 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * .\" Copyright 2002-2015,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,44 +27,44 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgrnd.3x,v 1.11 2020/02/02 23:34:34 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.15 2022/02/12 20:06:41 tom Exp $ .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. .TH curs_bkgrnd 3X "" .SH NAME -\fBbkgrnd\fR, -\fBwbkgrnd\fR, -\fBbkgrndset\fR, -\fBwbkgrndset\fR, -\fBgetbkgrnd\fR, -\fBwgetbkgrnd\fR \- \fBcurses\fR window complex background manipulation routines +\fBbkgrnd\fP, +\fBwbkgrnd\fP, +\fBbkgrndset\fP, +\fBwbkgrndset\fP, +\fBgetbkgrnd\fP, +\fBwgetbkgrnd\fP \- \fBcurses\fP window complex background manipulation routines .SH SYNOPSIS .PP .B #include .sp -\fBint bkgrnd(\fR\fB const cchar_t *\fR\fIwch\fR\fB);\fR +\fBint bkgrnd(\fB const cchar_t *\fIwch\fB);\fR .br -\fBint wbkgrnd(\fR\fB WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR -.br -\fBvoid bkgrndset(const cchar_t *\fR\fIwch\fR \fB);\fR -.br -\fBvoid wbkgrndset(WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR +\fBint wbkgrnd(\fB WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR +.sp +\fBvoid bkgrndset(const cchar_t *\fIwch\fR \fB);\fR .br -\fBint getbkgrnd(cchar_t *\fR\fIwch\fR\fB);\fR +\fBvoid wbkgrndset(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR +.sp +\fBint getbkgrnd(cchar_t *\fIwch\fB);\fR .br -\fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR +\fBint wgetbkgrnd(WINDOW *\fIwin\fB, cchar_t *\fIwch\fB);\fR .br .SH DESCRIPTION .SS bkgrndset .PP -The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the +The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the background of the named window. -The window background is a \fBcchar_t\fR consisting of +The window background is a \fBcchar_t\fP 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. +characters that are written into the window with \fBwaddch\fP. Both the character and attribute parts of the background are combined with the blank characters. @@ -77,7 +77,7 @@ 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 +The \fBbkgrnd\fP and \fBwbkgrnd\fP functions set the background property of the current or specified window and then apply this setting to every character position in that window: .bP @@ -88,15 +88,15 @@ Wherever the former background character appears, it is changed to the new background character. .SS getbkgrnd .PP -The \fBgetbkgrnd\fR function returns the given window's current background -character/attribute pair via the \fBwch\fR pointer. +The \fBgetbkgrnd\fP function returns the given window's current background +character/attribute pair via the \fBwch\fP 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 +\fBbkgrnd\fP, +\fBbkgrndset\fP, and +\fBgetbkgrnd\fP may be macros. .PP X/Open Curses does not provide details on how the rendition is changed. @@ -104,10 +104,10 @@ 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. +The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value. .PP -Upon successful completion, the other functions return \fBOK\fR. -Otherwise, they return \fBERR\fR: +Upon successful completion, the other functions return \fBOK\fP. +Otherwise, they return \fBERR\fP: .bP A null window pointer is treated as an error. .bP @@ -117,5 +117,5 @@ A null character pointer is treated as an error. These functions are described in the XSI Curses standard, Issue 4 (X/Open Curses). .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_bkgd\fR(3X) +\fBcurses\fP(3X), +\fBcurs_bkgd\fP(3X)