'\" t.\"***************************************************************************.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *.\"                                                                          *.\" Permission is hereby granted, free of charge, to any person obtaining a  *.\" copy of this software and associated documentation files (the            *.\" "Software"), to deal in the Software without restriction, including      *.\" without limitation the rights to use, copy, modify, merge, publish,      *.\" distribute, distribute with modifications, sublicense, and/or sell       *.\" copies of the Software, and to permit persons to whom the Software is    *.\" furnished to do so, subject to the following conditions:                 *.\"                                                                          *.\" The above copyright notice and this permission notice shall be included  *.\" in all copies or substantial portions of the Software.                   *.\"                                                                          *.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *.\"                                                                          *.\" Except as contained in this notice, the name(s) of the above copyright   *.\" holders shall not be used in advertising or otherwise to promote the     *.\" sale, use or other dealings in this Software without prior written       *.\" authorization.                                                           *.\"***************************************************************************.\".\" $Id: curs_attr.3x,v 1.27 2003/12/27 18:50:51 tom Exp $.TH curs_attr 3X "".SH NAME\fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR,\fBattrset\fR, \fBwattrset\fR, \fBcolor_set\fR, \fBwcolor_set\fR,\fBstandend\fR, \fBwstandend\fR, \fBstandout\fR, \fBwstandout\fR,\fBattr_get\fR, \fBwattr_get\fR,\fBattr_off\fR, \fBwattr_off\fR,\fBattr_on\fR, \fBwattr_on\fR,\fBattr_set\fR, \fBwattr_set\fR,\fBchgat\fR, \fBwchgat\fR,\fBmvchgat\fR, \fBmvwchgat\fR,\fBPAIR_NUMBER\fR - \fBcurses\fR character and window attribute control routines.SH SYNOPSIS\fB#include <curses.h>\fR.br\fBint attroff(int attrs);\fR.br\fBint wattroff(WINDOW *win, int attrs);\fR.br\fBint attron(int attrs);\fR.br\fBint wattron(WINDOW *win, int attrs);\fR.br\fBint attrset(int attrs);\fR.br\fBint wattrset(WINDOW *win, int attrs);\fR.br\fBint color_set(short color_pair_number, void* opts);\fR.br\fBint wcolor_set(WINDOW *win, short color_pair_number,\fR      \fBvoid* opts);\fR.br\fBint standend(void);\fR.br\fBint wstandend(WINDOW *win);\fR.br\fBint standout(void);\fR.br\fBint wstandout(WINDOW *win);\fR.br\fBint attr_get(attr_t *attrs, short *pair, void *opts);\fR.br\fBint wattr_get(WINDOW *win, attr_t *attrs, short *pair,\fR       \fBvoid *opts);\fR.br\fBint attr_off(attr_t attrs, void *opts);\fR.br\fBint wattr_off(WINDOW *win, attr_t attrs, void *opts);\fR.br\fBint attr_on(attr_t attrs, void *opts);\fR.br\fBint wattr_on(WINDOW *win, attr_t attrs, void *opts);\fR.br\fBint attr_set(attr_t attrs, short pair, void *opts);\fR.br\fBint wattr_set(WINDOW *win, attr_t attrs, short pair, void *opts);\fR.br\fBint chgat(int n, attr_t attr, short color,\fR      \fBconst void *opts)\fR.br\fBint wchgat(WINDOW *win, int n, attr_t attr,\fR      \fBshort color, const void *opts)\fR.br\fBint mvchgat(int y, int x, int n, attr_t attr,\fR      \fBshort color, const void *opts)\fR.br\fBint mvwchgat(WINDOW *win, int y, int x, int n,\fR      \fBattr_t attr, short color, const void *opts)\fR.br.SH DESCRIPTIONThese routines manipulate the current attributes of the named window.  Thecurrent attributes of a window apply to all characters that are written intothe window with \fBwaddch\fR, \fBwaddstr\fR and \fBwprintw\fR.  Attributes area property of the character, and move with the character through any scrollingand insert/delete line/character operations.  To the extent possible, they aredisplayed as appropriate modifications to the graphic rendition of charactersput on the screen..PPThe routine \fBattrset\fR sets the current attributes of the given window to\fIattrs\fR.  The routine \fBattroff\fR turns off the named attributes withoutturning any other attributes on or off.  The routine \fBattron\fR turns on thenamed attributes without affecting any others.  The routine \fBstandout\fR isthe same as \fBattron(A_STANDOUT)\fR.  The routine \fBstandend\fR is the sameas \fBattrset(A_NORMAL)\fR or \fBattrset(0)\fR, that is, it turns off allattributes..PPThe \fBattrset\fR and related routines do not affect the attributes usedwhen erasing portions of the window.See \fBcurs_bkgd\fR(3X) for functions which modify the attributes used forerasing and clearing..PPThe routine \fBcolor_set\fR sets the current color of the given window to theforeground/background combination described by the color_pair_number. Theparameter opts is reserved for future use, applications must supply a nullpointer..PPThe routine \fBwattr_get\fR returns the current attribute and color pair forthe given window; \fBattr_get\fR returns the current attribute and color pairfor \fBstdscr\fR.The remaining \fBattr_\fR* functions operate exactly like the corresponding\fBattr\fR* functions, except that they take arguments of type \fBattr_t\fRrather than \fBint\fR..PPThe routine \fBchgat\fR changes the attributes of a given number of charactersstarting at the current cursor location of \fBstdscr\fR.  It does not updatethe cursor and does not perform wrapping.  A character count of -1 or greaterthan the remaining window width means to change attributes all the way to theend of the current line.  The \fBwchgat\fR function generalizes this to anywindow; the \fBmvwchgat\fR function does a cursor move before acting.  In thesefunctions, the color argument is a color-pair index (as in the first argumentof \fIinit_pair\fR, see \fBcurs_color\fR(3X)).  The \fBopts\fR argument is notpresently used, but is reserved for the future (leave it \fBNULL\fR).Note that changing the attributes does not implythat a subsequent \fBrefresh\fR will update the screen to match,since the character values are not modified.Use \fBtouchwin\fR to force the screen to match the updated attributes..SS AttributesThe following video attributes, defined in \fB<curses.h>\fR, can be passed tothe routines \fBattron\fR, \fBattroff\fR, and \fBattrset\fR, or OR'ed with thecharacters passed to \fBaddch\fR..PP.TScenter ;l l .\fBA_NORMAL\fR	Normal display (no highlight)\fBA_STANDOUT\fR	Best highlighting mode of the terminal.\fBA_UNDERLINE\fR	Underlining\fBA_REVERSE\fR	Reverse video\fBA_BLINK\fR	Blinking\fBA_DIM\fR	Half bright\fBA_BOLD\fR	Extra bright or bold\fBA_PROTECT\fR	Protected mode\fBA_INVIS\fR	Invisible or blank mode\fBA_ALTCHARSET\fR	Alternate character set\fBA_CHARTEXT\fR	Bit-mask to extract a character\fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR	Color-pair number \fIn\fR.TE.PPThe following macro is the reverse of \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR:.PP.br\fBPAIR_NUMBER(\fR\fIattrs\fR) Returns the pair number associated                   with the \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR attribute..br.PPThe return values of many of these routines are not meaningful (they areimplemented as macro-expanded assignments and simply return their argument).The SVr4 manual page claims (falsely) that these routines always return \fB1\fR..SH NOTESNote that \fBattroff\fR, \fBwattroff\fR, \fBattron\fR, \fBwattron\fR,\fBattrset\fR, \fBwattrset\fR, \fBstandend\fR and \fBstandout\fR may be macros..SH PORTABILITYAll these functions are supported in the XSI Curses standard, Issue 4.  Thestandard defined the dedicated type for highlights, \fBattr_t\fR, which is notdefined in SVr4 curses. The functions taking \fBattr_t\fR arguments arenot supported under SVr4..PPThe XSI Curses standard states that whether the traditional functions\fBattron\fR/\fBattroff\fR/\fBattrset\fR can manipulate attributes other than\fBA_BLINK\fR, \fBA_BOLD\fR, \fBA_DIM\fR, \fBA_REVERSE\fR, \fBA_STANDOUT\fR, or\fBA_UNDERLINE\fR is "unspecified".  Under this implementation as well asSVr4 curses, these functions correctly manipulate all other highlights(specifically, \fBA_ALTCHARSET\fR, \fBA_PROTECT\fR, and \fBA_INVIS\fR)..PPXSI Curses added the new entry points, \fBattr_get\fR, \fBattr_on\fR,\fBattr_off\fR, \fBattr_set\fR, \fBwattr_on\fR, \fBwattr_off\fR,\fBwattr_get\fR, \fBwattr_set\fR.  These are intended to work witha new series of highlight macros prefixed with \fBWA_\fR..PP.TScenter ;l l .\fBWA_NORMAL\fR	Normal display (no highlight)\fBWA_STANDOUT\fR	Best highlighting mode of the terminal.\fBWA_UNDERLINE\fR	Underlining\fBWA_REVERSE\fR	Reverse video\fBWA_BLINK\fR	Blinking\fBWA_DIM\fR	Half bright\fBWA_BOLD\fR	Extra bright or bold\fBWA_ALTCHARSET\fR	Alternate character set.TE.PPThe XSI curses standard specifies that each pair of corresponding \fBA_\fRand \fBWA_\fR-using functions operates on the same current-highlightinformation..PPThe XSI standard extended conformance level adds new highlights\fBA_HORIZONTAL\fR, \fBA_LEFT\fR, \fBA_LOW\fR, \fBA_RIGHT\fR, \fBA_TOP\fR,\fBA_VERTICAL\fR (and corresponding \fBWA_\fR macros for each) which thiscurses does not yet support..SH SEE ALSO\fBcurses\fR(3X),\fBcurs_addch\fR(3X),\fBcurs_addstr\fR(3X),\fBcurs_bkgd\fR(3X),\fBcurs_printw\fR(3X).\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: