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=d83bd63307c1ca469fcbd32317b2b9afc50328f5;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html index d83bd633..4e86eeee 100644 --- a/doc/html/man/curs_bkgrnd.3x.html +++ b/doc/html/man/curs_bkgrnd.3x.html @@ -1,7 +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, wget-
-       bkgrnd - curses  window  complex  background  manipulation
-       routines
+

NAME

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

SYNOPSIS

-       #include <curses.h>
+

SYNOPSIS

+       #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);
 
-
-

DESCRIPTION

-       The bkgrndset and wbkgrndset routines manipulate the back-
-       ground 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  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.
+       int getbkgrnd(cchar_t *wch);
+       int wgetbkgrnd(WINDOW *win, cchar_t *wch);
 
-       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.
 
-       The  bkgrnd and wbkgrnd functions set the background prop-
-       erty of the current or specified  window  and  then  apply
-       this setting to every character position in that window:
+

DESCRIPTION

 
-              The  rendition  of every character on the screen is
-              changed to the new background rendition.
+

bkgrndset

+       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
+       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.
 
-              Wherever the former background  character  appears,
-              it is changed to the new background character.
+       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.
 
-       The  getbkgrnd function returns the given window's current
-       background character/attribute pair via the wch pointer.
 
+

bkgrnd

+       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
+           new background rendition.
 
-
-

NOTES

-       Note that bkgrnd, bkgrndset, and getbkgrnd may be  macros.
+       o   Wherever  the former background character appears, it is changed to
+           the new background character.
 
 
-
-

RETURN VALUES

-       The  bkgrndset  and  wbkgrndset  routines  do not return a
-       value.
+

getbkgrnd

+       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).
 
-       Upon successful completion, the other functions return OK.
-       Otherwise,  they  return  ERR.   A  null window pointer is
-       treated as an error.
 
+

NOTES

+       Note that bkgrnd, bkgrndset, and getbkgrnd may be macros.
 
-
-

SEE ALSO

-       curses(3x), curs_bkgd(3x)
+       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.
+
+       Upon successful completion, the other functions return OK.   Otherwise,
+       they return ERR:
+
+       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).
+
+
+

SEE ALSO

+       curses(3X), curs_bkgd(3X)
 
 
 
-                                                        curs_bkgrnd(3x)
+                                                               curs_bkgrnd(3X)
-
-
-Man(1) output converted with -man2html -
+
+ +