X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_bkgd.3x;h=14403c32a5a1847dc0740fa30365fb43124a7a77;hp=a256999765611ad3425118ee3b021b3833d4e4c9;hb=d448186ac240901c6976dc74c260f052d3ed53e4;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x index a2569997..14403c32 100644 --- a/man/curs_bkgd.3x +++ b/man/curs_bkgd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2010 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,26 +26,25 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.12 1998/03/14 23:43:31 tom Exp $ +.\" $Id: curs_bkgd.3x,v 1.21 2010/07/31 14:36:04 tom Exp $ .TH curs_bkgd 3X "" .SH NAME -\fBbkgdset\fR, \fBwbkgdset\fR, \fBbkgd\fR, -\fBwbkgd\fR - \fBcurses\fR window background manipulation routines -.. +\fBbkgdset\fR, \fBwbkgdset\fR, +\fBbkgd\fR, \fBwbkgd\fR, +\fBgetbkgd\fR \- \fBcurses\fR window background manipulation routines .SH SYNOPSIS \fB#include \fR - -\fBvoid bkgdset(const chtype ch);\fR +.PP +\fBvoid bkgdset(chtype ch);\fR .br -\fBvoid wbkgdset(WINDOW *win, const chtype ch);\fR +\fBvoid wbkgdset(WINDOW *win, chtype ch);\fR .br -\fBint bkgd(const chtype ch);\fR +\fBint bkgd(chtype ch);\fR .br -\fBint wbkgd(WINDOW *win, const chtype ch);\fR +\fBint wbkgd(WINDOW *win, chtype ch);\fR .br \fBchtype getbkgd(WINDOW *win);\fR .br -.. .SH DESCRIPTION The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the background of the named window. @@ -57,42 +56,40 @@ the character and attribute parts of the background are combined with 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. - -To the extent possible on a -particular terminal, the attribute part of the background is displayed +.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. - +.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: - +.PP .RS The rendition of every character on the screen is changed to the new background rendition. - +.PP Wherever the former background character appears, it is changed to the new background character. .RE - +.PP The \fBgetbkgd\fR function returns the given window's current background character/attribute pair. -.. .SH RETURN VALUE 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 Note that \fBbkgdset\fR and \fBbkgd\fR may be macros. -.. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. The draft -does not include \fBconst\fR qualifiers on the arguments. The standard -specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR, on failure. but -gives no failure conditions. -.. +These functions are described in the XSI Curses standard, Issue 4. +It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure, +but gives no failure conditions. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_outopts\fR(3X) +\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: