X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgd.3x;h=2dc21e6a9c062025cd1e3cd2d9888752bbad4b3b;hp=f5c620db55cf065cf052257305a0e48b0626427a;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x index f5c620db..2dc21e6a 100644 --- a/man/curs_bkgd.3x +++ b/man/curs_bkgd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2000,2002 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-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,74 +26,80 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.18 2002/09/21 19:46:26 tom Exp $ +.\" $Id: curs_bkgd.3x,v 1.26 2018/07/28 21:34:06 tom Exp $ +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .TH curs_bkgd 3X "" .SH NAME \fBbkgdset\fR, \fBwbkgdset\fR, \fBbkgd\fR, \fBwbkgd\fR, -\fBgetbkgd\fR - \fBcurses\fR window background manipulation routines - +\fBgetbkgd\fR \- \fBcurses\fR window background manipulation routines .SH SYNOPSIS \fB#include \fR - -\fBvoid bkgdset(chtype ch);\fR +.PP +\fBvoid bkgdset(chtype \fP\fIch\fP\fB);\fR .br -\fBvoid wbkgdset(WINDOW *win, chtype ch);\fR +\fBvoid wbkgdset(WINDOW *\fP\fIwin, chtype \fP\fIch\fP\fB);\fR .br -\fBint bkgd(chtype ch);\fR +\fBint bkgd(chtype \fP\fIch\fP\fB);\fR .br -\fBint wbkgd(WINDOW *win, chtype ch);\fR +\fBint wbkgd(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB);\fR .br -\fBchtype getbkgd(WINDOW *win);\fR +\fBchtype getbkgd(WINDOW *\fP\fIwin\fP\fB);\fR .br .SH DESCRIPTION +.SS bkgdset The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the background of the named window. The window background is a \fBchtype\fR consisting of any combination of attributes (i.e., rendition) and a 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 +the blank characters. +The background becomes a property of the character and moves with the character through any scrolling and insert/delete line/character operations. - +.PP 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 bkgd +.PP The \fBbkgd\fR and \fBwbkgd\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. - +.bP Wherever the former background character appears, it is changed to the new background character. -.RE - +.SS getbkgd +.PP The \fBgetbkgd\fR function returns the given window's current background character/attribute pair. .SH RETURN VALUE +.PP The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR. The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set", but this appears to be an error. .SH NOTES +.PP Note that \fBbkgdset\fR and \fBbkgd\fR may be macros. .SH PORTABILITY +.PP These functions are described in the XSI Curses standard, Issue 4. -It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure. +It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure, but gives no failure conditions. .SH SEE ALSO +.na +.PP \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: