X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_attr.3x.html;h=aca62aec0e38c8b35fcade5b3af4a8264ae22ab0;hp=e4deb00f70e8015317977f0665d80144d9bd485a;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=0ac2306dd3aaab1338d8b1458c15a7e476cfc3ff diff --git a/doc/html/man/curs_attr.3x.html b/doc/html/man/curs_attr.3x.html index e4deb00f..aca62aec 100644 --- a/doc/html/man/curs_attr.3x.html +++ b/doc/html/man/curs_attr.3x.html @@ -1,8 +1,7 @@ - + + + curs_attr 3x -

curs_attr 3x

-
+

curs_attr 3x

-
 curs_attr(3x)                                             curs_attr(3x)
 
 
 
 
 
-

NAME

+

NAME

        attroff, wattroff, attron, wattron, attrset, wattrset,
        color_set, wcolor_set, standend, wstandend, standout,
        wstandout, attr_get, wattr_get, attr_off, wattr_off,
@@ -57,7 +57,7 @@
 
 
 
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
        int attroff(int attrs);
        int wattroff(WINDOW *win, int attrs);
@@ -93,7 +93,7 @@
 
 
 
-

DESCRIPTION

+

DESCRIPTION

        These  routines  manipulate  the current attributes of the
        named window.  The current attributes of a window apply to
        all characters that are written into the window with wadd-
@@ -143,23 +143,43 @@
        ment is not presently used, but is reserved for the future
        (leave it NULL).
 
-   Attributes
+
+
+

Attributes

        The following video attributes, defined in <curses.h>, can
        be passed to the routines attron, attroff, and attrset, or
        OR'd with the characters passed to addch.
 
-        A_NORMAL        Normal display (no highlight)
-        A_STANDOUT      Best highlighting mode of the terminal.
-        A_UNDERLINE     Underlining
-        A_REVERSE       Reverse video
-        A_BLINK         Blinking
-        A_DIM           Half bright
-        A_BOLD          Extra bright or bold
-        A_PROTECT       Protected mode
-        A_INVIS         Invisible or blank mode
-        A_ALTCHARSET    Alternate character set
-        A_CHARTEXT      Bit-mask to extract a character
-        COLOR_PAIR(n)   Color-pair number n
+              Name            Description
+              ------------------------------------------------------------
+              A_NORMAL        Normal display (no highlight)
+              A_STANDOUT      Best highlighting mode of the terminal.
+              A_UNDERLINE     Underlining
+              A_REVERSE       Reverse video
+              A_BLINK         Blinking
+              A_DIM           Half bright
+              A_BOLD          Extra bright or bold
+              A_PROTECT       Protected mode
+              A_INVIS         Invisible or blank mode
+              A_ALTCHARSET    Alternate character set
+              A_ITALIC        Italics (non-X/Open extension)
+              A_CHARTEXT      Bit-mask to extract a character
+              COLOR_PAIR(n)   Color-pair number n
+
+       These video attributes are supported by attr_on and relat-
+       ed functions (which also support the attributes recognized
+       by attron, etc.):
+
+              Name            Description
+              -----------------------------------------
+              WA_HORIZONTAL   Horizontal highlight
+              WA_LEFT         Left highlight
+              WA_LOW          Low highlight
+              WA_RIGHT        Right highlight
+              WA_TOP          Top highlight
+              WA_VERTICAL     Vertical highlight
+
+       For consistency
 
        The following macro is the reverse of COLOR_PAIR(n):
 
@@ -173,7 +193,7 @@
 
 
 
-

NOTES

+

NOTES

        Note  that  attroff,  wattroff,  attron, wattron, attrset,
        wattrset, standend and standout may be macros.
 
@@ -186,7 +206,7 @@
 
 
 
-

PORTABILITY

+

PORTABILITY

        These  functions are supported in the XSI Curses standard,
        Issue 4.  The standard  defined  the  dedicated  type  for
        highlights,  attr_t,  which is not defined in SVr4 curses.
@@ -201,36 +221,48 @@
        correctly manipulate all other  highlights  (specifically,
        A_ALTCHARSET, A_PROTECT, and A_INVIS).
 
+       This  implementation  provides  the A_ITALIC attribute for
+       terminals which have the enter_italics_mode (sitm) and ex-
+       it_italics_mode (ritm) capabilities.  Italics are not men-
+       tioned in X/Open  Curses.   Unlike  the  other  video  at-
+       tributes,  I_ITALIC is unrelated to the set_attributes ca-
+       pabilities.  This implementation makes the assumption that
+       exit_attribute_mode may also reset italics.
+
        XSI  Curses added the new entry points, attr_get, attr_on,
        attr_off, attr_set, wattr_on, wattr_off,  wattr_get,  wat-
        tr_set.   These  are intended to work with a new series of
-       highlight macros prefixed with WA_.
-
-       Older versions of this library did not force an update  of
-       the  screen when changing the attributes.  Use touchwin to
+       highlight macros prefixed with WA_.  The older macros have
+       direct counterparts in the newer set of names:
+
+              Name            Description
+              ------------------------------------------------------------
+              WA_NORMAL       Normal display (no highlight)
+              WA_STANDOUT     Best highlighting mode of the terminal.
+              WA_UNDERLINE    Underlining
+              WA_REVERSE      Reverse video
+              WA_BLINK        Blinking
+              WA_DIM          Half bright
+              WA_BOLD         Extra bright or bold
+              WA_ALTCHARSET   Alternate character set
+
+       Older  versions of this library did not force an update of
+       the screen when changing the attributes.  Use touchwin  to
        force the screen to match the updated attributes.
 
-        WA_NORMAL       Normal display (no highlight)
-        WA_STANDOUT     Best highlighting mode of the terminal.
-        WA_UNDERLINE    Underlining
-        WA_REVERSE      Reverse video
-        WA_BLINK        Blinking
-        WA_DIM          Half bright
-        WA_BOLD         Extra bright or bold
-        WA_ALTCHARSET   Alternate character set
-
        The XSI curses standard specifies that each pair of corre-
-       sponding  A_  and WA_-using functions operates on the same
+       sponding A_ and WA_-using functions operates on  the  same
        current-highlight information.
 
        The XSI standard extended conformance level adds new high-
        lights A_HORIZONTAL, A_LEFT, A_LOW, A_RIGHT, A_TOP, A_VER-
-       TICAL (and corresponding WA_ macros for each)  which  this
-       implementation does not yet support.
+       TICAL  (and corresponding WA_ macros for each).  As of Au-
+       gust 2013, no known  terminal  provides  these  highlights
+       (i.e., via the sgr1 capability).
 
 
 
-

RETURN VALUE

+

RETURN VALUE

        All  routines  return the integer OK on success, or ERR on
        failure.
 
@@ -248,18 +280,28 @@
 
 
 
-

SEE ALSO

+

SEE ALSO

        curses(3x),        curs_addch(3x),        curs_addstr(3x),
-       curs_bkgd(3x), curs_printw(3x)
+       curs_bkgd(3x), curs_printw(3x), curs_variables(3x)
 
 
 
                                                           curs_attr(3x)
 
-
-
-Man(1) output converted with -man2html -
+