X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_attr.3x;h=9e40018622c0dda2481f13b0e7969989736be913;hp=3cbaf535fe13fe9de949ec63be3490d2cc611e90;hb=d4ff840fddef2f6deb4a3daeb26d398a93b58dd2;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_attr.3x b/man/curs_attr.3x index 3cbaf535..9e400186 100644 --- a/man/curs_attr.3x +++ b/man/curs_attr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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 * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_attr.3x,v 1.29 2005/05/15 16:17:25 tom Exp $ +.\" $Id: curs_attr.3x,v 1.34 2010/08/14 23:30:02 tom Exp $ .TH curs_attr 3X "" .na .hy 0 @@ -56,7 +56,7 @@ \fBwchgat\fR, \fBmvchgat\fR, \fBmvwchgat\fR, -\fBPAIR_NUMBER\fR - \fBcurses\fR character and window attribute control routines +\fBPAIR_NUMBER\fR \- \fBcurses\fR character and window attribute control routines .ad .hy .SH SYNOPSIS @@ -152,17 +152,13 @@ rather than \fBint\fR. .PP The routine \fBchgat\fR changes the attributes of a given number of characters starting at the current cursor location of \fBstdscr\fR. It does not update -the cursor and does not perform wrapping. A character count of -1 or greater +the cursor and does not perform wrapping. A character count of \-1 or greater than the remaining window width means to change attributes all the way to the end of the current line. The \fBwchgat\fR function generalizes this to any window; the \fBmvwchgat\fR function does a cursor move before acting. In these functions, the color argument is a color-pair index (as in the first argument of \fIinit_pair\fR, see \fBcurs_color\fR(3X)). The \fBopts\fR argument is not presently used, but is reserved for the future (leave it \fBNULL\fR). -Note that changing the attributes does not imply -that 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 Attributes The following video attributes, defined in \fB\fR, can be passed to the routines \fBattron\fR, \fBattroff\fR, and \fBattrset\fR, or OR'd with the @@ -223,6 +219,11 @@ XSI Curses added the new entry points, \fBattr_get\fR, \fBattr_on\fR, \fBwattr_get\fR, \fBwattr_set\fR. These are intended to work with a new series of highlight macros prefixed with \fBWA_\fR. .PP +Older versions of this library did not force an update of the screen +when changing the attributes. +Use \fBtouchwin\fR to force the screen to match the updated attributes. +.PP +.ne 9 .TS center ; l l . @@ -252,7 +253,14 @@ X/Open does not define any error conditions. This implementation returns an error if the window pointer is null. The \fBwcolor_set\fP function returns an error if the color pair parameter -is outside the range 0..COLOR_PAIRS-1. +is outside the range 0..COLOR_PAIRS\-1. +This implementation also provides +\fBgetattrs\fR +for compatibility with older versions of curses. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addch\fR(3X),