attr_get.3x (2010 09)

attr_get(3X) attr_get(3X)

(ENHANCED CURSES)

NAME

attr_get, attr_off, attr_on, attr_set, color_set, wattr_get, wattr_off, wattr_on, wattr_set, wcolor_set — win-

dow attribute control functions

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);

DESCRIPTION

These functions manipulate the attributes and color of the window rendition of the current or speciﬁed

window.

The

attr_get() and wattr_get() functions obtain the current rendition of a window.

The

attr_off() and wattr_off() functions turn off attrs in the current or speciﬁed window without

affecting any others.

The

attr_on() and wattr_on() functions turn on attrs in the current or speciﬁed window without

affecting any others.

The

attr_set() and wattr_set() functions set the window rendition of the current or speciﬁed

window to attrs and color.

The

color_set() and wcolor_set() functions set the window color of the current or speciﬁed win-

dow to color.

The opts argument is reserved for deﬁnition in a future edition of this document. Currently, the applica-

tion must provide a null pointer as opts.

RETURN VALUE

These functions always return OK.

ERRORS

No errors are deﬁned.