bkgdset(3xcurses)

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

NAME

6       bkgd,  bkgdset,  getbkgd,  wbkgd,  wbkgdset - set or get the background
7       character (and rendition) of window
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int bkgd(chtype ch);
18
19
20       void bkgdset(chtype ch);
21
22
23       chtype getbkgd(WINDOW *win);
24
25
26       int wbkgd(WINDOW *win, chtype ch);
27
28
29       void wbkgdset(WINDOW *win, chtype ch);
30
31

DESCRIPTION

33       The bkgdset() and wbkgdset() functions turn off the previous background
34       attributes,  logical OR the requested attributes into the window rendi‐
35       tion, and set the background property of the current or specified  win‐
36       dow  based  on  the  information  in ch. If ch refers to a multi-column
37       character, the results are undefined.
38
39
40       The bkgd() and wbkgd()  functions  turn  off  the  previous  background
41       attributes,  logical OR the requested attributes into the window rendi‐
42       tion, and set the background property of the current or specified  win‐
43       dow  and  then  apply  this setting to every character position in that
44       window:
45
46           o      The rendition of every character on the screen is changed to
47                  the new window rendition.
48
49           o      Wherever  the  former  background  character  appears, it is
50                  changed to the new background character.
51
52
53       The getbkgd() function extracts the specified window's background char‐
54       acter and rendition.
55

PARAMETERS

57       ch     Is the background character to be set.
58
59
60       win    Is  a pointer to the window in which the background character is
61              to  be set.
62
63

RETURN VALUES

65       Upon successful completion, the bkgd() and wbkgd() functions return OK.
66       Otherwise, they return ERR.
67
68
69       The bkgdset() and wbkgdset() functions do not return a value.
70
71
72       Upon  successful  completion, the getbkgd() function returns the speci‐
73       fied window's background character and rendition. Otherwise, it returns
74       (chtype)ERR.
75

ERRORS

77       No errors are defined.
78

USAGE

80       These  functions  are  only guaranteed to operate reliably on character
81       sets in which each character fits into a single byte, whose  attributes
82       can be expressed using only constants with the A_ prefix.
83

ATTRIBUTES

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