illumos: manual page: attroff.3xcurses

ATTROFF(3XCURSES) X/Open Curses Library Functions ATTROFF(3XCURSES)

NAME

attroff, attron, attrset, wattroff, wattron, wattrset - change foreground
window attributes

SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int attroff(int attrs);

int attron(int attrs);

int attrset(int attrs);

int wattroff(WINDOW *win, int attrs);

int wattron(WINDOW *win, int attrs);

int wattrset(WINDOW *win, int attrs);

DESCRIPTION

The attroff() and attron() 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 wattroff() and wattron() functions unset or set the
specified attributes for window win.

The attrset() and wattrset() functions change the specified window
renditions of stdscr and win to new values; the old values are not
retained.

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

Here is an example that prints some text using the current window
rendition, adds underlining, changes the attributes, prints more text,
then changes the attributes back.

printw("This word is");
attron(A_UNDERLINE);
printw("underlined.");
attroff(A_NORMAL);
printw("This is back to normal text.\n");
refresh();

PARAMETERS

attrs
are the foreground window attributes to be set or unset.

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

RETURN VALUES

These functions always return OK or 1.

ERRORS

None.

USAGE

All of these functions may be macros.

ATTRIBUTES