attr_get(3XC)

NAME

attr_get, attr_off, attr_on, attr_set, color_set, wattr_get, wattr_off, wattr_on, wattr_set, wcolor_set − control window attributes

SYNOPSIS

#include <curses.h>

int attr_get (attr_t ∗attrs, short ∗color, void ∗opts);

int attr_off (attr_t attrs, void ∗opts);

int attr_on (attr_t attrs, void ∗opts);

int attr_set (attr_t attrs, short color, void ∗opts);

int color_set (short ∗color, void ∗opts);

int wattr_get (WINDOW ∗win, attr_t attrs, short ∗color,
void ∗opts);

int wattr_off (WINDOW ∗win, attr_t attrs, void ∗opts);

int wattr_on (WINDOW ∗win, attr_t attrs, void ∗opts);

int wattr_set (WINDOW ∗win, attr_t attrs, short color,
void ∗opts);

int wcolor_set (WINDOW ∗win, short color, void ∗opts);

ARGUMENTS

attrsIs a pointer to the foreground window attributes to be set or unset.

colorIs a pointer to a color pair number .

optsIs reserved for future use.

winIs a pointer to the window in which attribute changes are to be made.

DESCRIPTION

The attr_get() function retrieves the current rendition of stdscr. The wattr_get() function retrieves the current rendition of window win. If attrs or color is a null pointer, no information is retrieved.

The attr_off() and attr_on() functions unset and set, respectively, the specified window attributes of stdscr. These functions only affect the attributes specified; attributes that existed before the call are retained.

The wattr_off() and wattr_on() functions unset or set the specified attributes for window win.

The attr_set() and wattr_set() functions change the rendition of stdscr and win; the old values are not retained.

The color_set() and wcolor_set() functions set the window color of stdscr and win to color.

The attributes and color pairs that can be used are specified in the Attributes, Color Pairs, and Renditions section of the curses(3XC) man page.

RETURN VALUES

These functions always return OK.

ERRORS

None.

Museum

Related Articles