X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_bkgrnd.3x.html;h=a1ab9247d9b9e8d3c12fbb2cbd8378aa1c36548e;hp=d5e9959a26235ae2b4f21e9c5b8bccd69f2eab08;hb=a90dd7b66fa711acd24d8181ea20e4f57d4b36cd;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d diff --git a/doc/html/man/curs_bkgrnd.3x.html b/doc/html/man/curs_bkgrnd.3x.html index d5e9959a..a1ab9247 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)

NAME

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

SYNOPSIS

@@ -65,51 +65,61 @@

DESCRIPTION

bkgrndset

-       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.
-
-       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 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 charac-
+       ter   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 as the graphic rendition of the character
+       put on the screen.

bkgrnd

-       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:
+       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:
 
-       o   The  rendition  of  every  character  on the screen is
-           changed to the new background rendition.
+       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 the new background character.
+       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.
+       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.
 
+       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.
+
+       o   A null character pointer is treated as an error.
+
 
-       Upon successful completion, the other functions return OK.
-       Otherwise, they return ERR.   A  null  window  pointer  is
-       treated as an error.
+

PORTABILITY

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