attr_on(3xcurses)

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

NAME

6       attr_get, attr_off, attr_on, attr_set, color_set, wattr_get, wattr_off,
7       wattr_on, wattr_set, wcolor_set - control window attributes
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 attr_get(attr_t *attrs, short *color, void *opts);
18
19
20       int attr_off(attr_t attrs, void *opts);
21
22
23       int attr_on(attr_t attrs, void *opts);
24
25
26       int attr_set(attr_t attrs, short color, void *opts);
27
28
29       int color_set(short *color, void *opts);
30
31
32       int wattr_get(WINDOW *win, attr_t attrs, short *color, void *opts);
33
34
35       int wattr_off(WINDOW *win, attr_t attrs, void *opts);
36
37
38       int wattr_on(WINDOW *win, attr_t attrs, void *opts);
39
40
41       int wattr_set(WINDOW *win, attr_t attrs, short color, void *opts);
42
43
44       int wcolor_set(WINDOW *win, short color, void *opts);
45
46

DESCRIPTION

48       The attr_get() function retrieves the current rendition of stdscr.  The
49       wattr_get()  function  retrieves  the current rendition of window  win.
50       If attrs or color is a null pointer, no information is retrieved.
51
52
53       The attr_off() and attr_on() functions unset  and  set,   respectively,
54       the specified window attributes of stdscr.  These functions only affect
55       the attributes specified; attributes that existed before the  call  are
56       retained.
57
58
59       The  wattr_off()  and  wattr_on() functions unset or set the  specified
60       attributes for window win.
61
62
63       The attr_set() and wattr_set() functions change the rendition of stdscr
64       and win; the old values are not retained.
65
66
67       The color_set() and wcolor_set() functions set the window color of std‐
68       scr and win to color.
69
70
71       The attributes and color pairs that can be used are  specified  in  the
72       Attributes,    Color    Pairs,    and   Renditions   section   of   the
73       curses(3XCURSES) man page.
74

PARAMETERS

76       attrs    Is a pointer to the foreground window attributes to be set  or
77                unset.
78
79
80       color    Is a pointer to a color pair number .
81
82
83       opts     Is reserved for future use.
84
85
86       win      Is  a  pointer to the window in which attribute changes are to
87                be made.
88
89

RETURN VALUES

91       These functions always return OK.
92

ERRORS

94       None.
95

ATTRIBUTES

97       See attributes(5) for descriptions of the following attributes:
98
99
100
101
102       ┌─────────────────────────────┬─────────────────────────────┐
103       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
104       ├─────────────────────────────┼─────────────────────────────┤
105       │Interface Stability          │Standard                     │
106       ├─────────────────────────────┼─────────────────────────────┤
107       │MT-Level                     │Unsafe                       │
108       └─────────────────────────────┴─────────────────────────────┘
109