wgetbkgrnd(3xcurses)

1bkgrnd(3XCURSES)        X/Open Curses Library Functions       bkgrnd(3XCURSES)
2
3
4

NAME

6       bkgrnd,  bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd - set or
7       get the background character (and rendition) of window using a  complex
8       character
9

SYNOPSIS

11       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
12        -R  /usr/xpg4/lib  -lcurses  [ library... ]
13
14       c89 [ flag... ] file... -lcurses [ library... ]
15
16       #include <curses.h>
17
18       int bkgrnd(const cchar_t *wch);
19
20
21       void bkgrndset(const cchar_t *wch);
22
23
24       int getbkgrnd(cchar_t *wch);
25
26
27       int wbkgrnd(WINDOW *win, const cchar_t *wch);
28
29
30       void wbkgrndset(WINDOW *win, const cchar_t *wch);
31
32
33       int wgetbkgrnd(WINDOW *win, cchar_t *wch);
34
35

DESCRIPTION

37       The  bkgrndset() and wbkgrndset() functions turn off the previous back‐
38       ground attributes, logical OR the requested attributes into the  window
39       rendition,  and set the background property of the current or specified
40       window based on the information in wch.
41
42
43       The bkgrnd() and wbkgrnd() functions turn off the  previous  background
44       attributes,  logical OR the requested attributes into the window rendi‐
45       tion, and set the background property of the current or specified  win‐
46       dow  and  then  apply  this setting to every character position in that
47       window:
48
49           o      The rendition of every character on the screen is changed to
50                  the new window rendition.
51
52           o      Wherever  the  former  background  character  appears, it is
53                  changed to the new background character.
54
55
56       If wch refers to a non-spacing complex character for bkgrnd(),  bkgrnd‐
57       set(),  wbkgrnd(),  and wbkgrndset(), then wch is added to the existing
58       spacing complex character that is  the  background  character.  If  wch
59       refers to a multi-column character, the results are unspecified.
60
61
62       The getbkgrnd() and wgetbkgrnd() functions store, into the area pointed
63       to buy wch, the window's background character and rendition.
64

PARAMETERS

66       wch    Is a pointer to the complex background character to be set.
67
68
69       win    Is a pointer to the window in which the complex background char‐
70              acter is to  be set.
71
72

RETURN VALUES

74       The bkgrndset() and wbkgrndset() functions do not return a value.
75
76
77       Upon  successful  completion, the other functions return OK. Otherwise,
78       they return ERR.
79

ERRORS

81       No errors are defined.
82

ATTRIBUTES

84       See attributes(5) for descriptions of the following attributes:
85
86
87
88
89       ┌─────────────────────────────┬─────────────────────────────┐
90       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
91       ├─────────────────────────────┼─────────────────────────────┤
92       │Interface Stability          │Standard                     │
93       ├─────────────────────────────┼─────────────────────────────┤
94       │MT-Level                     │Unsafe                       │
95       └─────────────────────────────┴─────────────────────────────┘
96