NAME

curs_attr_get, attr_get, wattr_get, attr_off, wattr_off, attr_on, wattr_on, attr_set, wattr_set, color_set, wcolor_set − Functions that control Curses window attributes

LIBRARY

Curses Library (libcurses.a, libcurses.so)

SYNOPSIS

#include <curses.h>

int attr_get(attr_t ∗attrs, short ∗color_pair,
        void ∗opts);
int wattr_get(WINDOW ∗win, attr_t ∗attrs,
        short ∗color_pair, void ∗opts);
int attr_off(attr_t attrs, void ∗opts);
int wattr_off(WINDOW ∗win, attr_t attrs,
        void ∗opts);
int attr_on(attr_t attrs, void ∗opts);
int wattr_on(WINDOW ∗win, attr_t attrs,
        void ∗opts);
int attr_set(attr_t attrs, short color_pair,
        void ∗opts);
int wattr_set(WINDOW ∗win, attr_t attrs,
        short color_pair, void ∗opts);
int color_set(short color_pair, void ∗opts);
int wcolor_set(WINDOW ∗win, short color_pair,
        void ∗opts);

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

attr_get, wattr_get, attr_off, wattr_off, attr_on, wattr_on, attr_set, wattr_set:  XPG4−UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags. 

DESCRIPTION

These functions manipulate the attributes and color of the window rendition of the current or specified window.  The current attributes of a window are applied to all characters that are written into the window.  These attributes become property of the character and move with the character through any scrolling and insert/delete line/character operations.  To the extent possible on the particular terminal, attributes are displayed as the graphic rendition of characters put on the screen. 

The attr_get and wattr_get functions obtain the window rendition of the current or specified window. If attrs or color_pair is a null pointer, the functions do not obtain corresponding rendition information; this condition is not an error. 

The attr_off and wattr_off functions turn off the named attributes, without affecting other attributes, for the current or specified window. 

The attr_on and wattr_on functions turn on the named attributes, without affecting other attributes, for the current or specified window. 

The attr_set and wattr_set functions set the window rendition of the current or specified window in conjunction with the window background rendition. 

The color_set and wcolor_set functions set the window color of the current or specified window to color_pair. 

The opts argument in all the preceding functions is reserved for future use. Currently, applications must provide a null pointer for the opts argument. 

Attributes

Applications can pass the following video attributes, which are defined in curses.h, to these routines in place of attrs to turn on or off the corresponding attribute. More than one attribute can be passed by using an inclusive OR operation. 

WA_ALTCHARSETAlternate character set

WA_BLINKBlinking

WA_BOLDExtra bright or bold

WA_DIMHalf bright

WA_HORIZONTALHorizontal highlight

WA_INVISInvisible

WA_LEFTLeft highlight

WA_LOWLow highlight

WA_PROTECTProtected

WA_REVERSEReverse video

WA_RIGHTRight highlight

WA_STANDOUTBest highlighting mode of the terminal. 

WA_TOPTop highlight

WA_UNDERLINEUnderlining

WA_VERTICALVertical highlight

NOTES

The header file curses.h automatically includes the header file stdio.h. 

Note that attr_get, attr_off, attr_on, attr_set, and color_set may be macros. 

RETURN VALUES

These routines always return OK. 

RELATED INFORMATION

Functions: curses(3), curs_addch(3), curs_add_wch(3), curs_addwstr(3), curs_printw(3), curs_color(3)

Others: standards(5)