X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgrnd.3x.html;h=4e86eeeec0081b23b12e044b1f38b3482dfb2719;hp=4e3dc419560530062a75f345729095436f3d927c;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html index 4e3dc419..4e86eeee 100644 --- a/doc/html/man/curs_bkgrnd.3x.html +++ b/doc/html/man/curs_bkgrnd.3x.html @@ -1,6 +1,7 @@ - -curs_bkgrnd 3x - +curs_bkgrnd 3X + -

curs_bkgrnd 3x

curs_bkgrnd 3X

-curs_bkgrnd(3x)                                                curs_bkgrnd(3x)
+curs_bkgrnd(3X)                                                curs_bkgrnd(3X)

NAME

-       bkgrnd,  wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - curses
+       bkgrnd,  wbkgrnd, bkgrndset, wbkgrndset, getbkgrnd, wgetbkgrnd - curses
        window complex background manipulation routines

SYNOPSIS

-       #include <curses.h>
+       #include <curses.h>
 
-       int bkgrnd( const cchar_t *wch);
-       int wbkgrnd( WINDOW *win, const cchar_t *wch);
-       void bkgrndset(const cchar_t *wch );
-       void wbkgrndset(WINDOW *win, const cchar_t *wch);
-       int getbkgrnd(cchar_t *wch);
-       int wgetbkgrnd(WINDOW *win, cchar_t *wch);
+       int bkgrnd( const cchar_t *wch);
+       int wbkgrnd( WINDOW *win, const cchar_t *wch);
+
+       void bkgrndset(const cchar_t *wch );
+       void wbkgrndset(WINDOW *win, const cchar_t *wch);
+
+       int getbkgrnd(cchar_t *wch);
+       int wgetbkgrnd(WINDOW *win, cchar_t *wch);

DESCRIPTION

bkgrndset

-       The bkgrndset and wbkgrndset routines manipulate the background of  the
-       named  window.   The  window  background is a cchar_t consisting of any
+       The bkgrndset and wbkgrndset routines manipulate the background of  the
+       named  window.   The  window  background is a cchar_t 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  waddch.   Both
+       blank characters that are written into the window  with  waddch.   Both
        the  character  and attribute parts of the background are combined with
-       the blank characters.  The background becomes a property of the charac-
-       ter   and   moves   with   the  character  through  any  scrolling  and
+       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
@@ -80,44 +83,53 @@

bkgrnd

-       The bkgrnd and wbkgrnd functions set the  background  property  of  the
-       current  or specified window and then apply this setting to every char-
-       acter position in that window:
+       The bkgrnd and wbkgrnd functions set the  background  property  of  the
+       current  or  specified  window  and  then  apply  this setting to every
+       character position in that window:
 
-       o   The rendition of every character on the screen is  changed  to  the
+       o   The rendition of every character on the screen is  changed  to  the
            new background rendition.
 
-       o   Wherever  the former background character appears, it is changed to
+       o   Wherever  the former background character appears, it is changed to
            the new background character.

getbkgrnd

-       The getbkgrnd function returns the given  window's  current  background
-       character/attribute  pair  via  the  wch  pointer.  If the given window
+       The getbkgrnd function returns the given  window's  current  background
+       character/attribute  pair  via  the  wch  pointer.  If the given window
        pointer is null, the character is not updated (but no error returned).

NOTES

-       Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
+       Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
+
+       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 wbkgd.

RETURN VALUE

-       The bkgrndset and wbkgrndset routines do not return a value.
+       The bkgrndset and wbkgrndset routines do not return a value.
+
+       Upon successful completion, the other functions return OK.   Otherwise,
+       they return ERR:
+
+       o   A null window pointer is treated as an error.
 
-       Upon successful completion, the other functions return OK.   Otherwise,
-       they return ERR:
+       o   A null character pointer is treated as an error.
 
-       o   A null window pointer is treated as an error.
 
-       o   A null character pointer is treated as an error.
+

PORTABILITY

+       These  functions  are  described  in  the  XSI Curses standard, Issue 4
+       (X/Open Curses).