X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_color.3x.html;h=974a68f21e519642e8d3c17f259a0fea2aece841;hp=2165cebf4ff82d394fffb78f366a3dc639835454;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01
diff --git a/doc/html/man/curs_color.3x.html b/doc/html/man/curs_color.3x.html
index 2165cebf..974a68f2 100644
--- a/doc/html/man/curs_color.3x.html
+++ b/doc/html/man/curs_color.3x.html
@@ -1,7 +1,7 @@
@@ -40,11 +40,15 @@
+curs_color(3x) curs_color(3x)
+
+
+
NAME
- start_color, init_pair, init_color, has_colors,
- can_change_color, color_content, pair_content, COLOR_PAIR
+ start_color, init_pair, init_color, has_colors,
+ can_change_color, color_content, pair_content, COLOR_PAIR
- curses color manipulation routines
@@ -64,8 +68,8 @@
DESCRIPTION
Overview
- curses support color attributes on terminals with that
- capability. To use these routines start_color must be
+ curses support color attributes on terminals with that ca-
+ pability. To use these routines start_color must be
called, usually right after initscr. Colors are always
used in pairs (referred to as color-pairs). A color-pair
consists of a foreground color (for characters) and a
@@ -80,11 +84,11 @@
nition of a color. The routines has_colors and
can_change_color return TRUE or FALSE, depending on
whether the terminal has color capabilities and whether
- the programmer can change the colors. The routine
- color_content allows a programmer to extract the amounts
- of red, green, and blue components in an initialized
- color. The routine pair_content allows a programmer to
- find out how a given color-pair is currently defined.
+ the programmer can change the colors. The routine col-
+ or_content allows a programmer to extract the amounts of
+ red, green, and blue components in an initialized color.
+ The routine pair_content allows a programmer to find out
+ how a given color-pair is currently defined.
Routine Descriptions
The start_color routine requires no arguments. It must be
@@ -105,41 +109,46 @@
background color number. For portable applications:
- The value of the first argument must be between 1 and
- COLOR_PAIRS-1.
-
- - The value of the second and third arguments must be
- between 0 and COLORS (the 0 color pair is wired to
- white on black and cannot be changed).
-
- If the color-pair was previously initialized, the screen
- is refreshed and all occurrences of that color-pair are
+ COLOR_PAIRS-1, except that if default colors are used
+ (see use_default_colors) the upper limit is adjusted
+ to allow for extra pairs which use a default color in
+ foreground and/or background.
+
+ - The value of the second and third arguments must be
+ between 0 and COLORS. Color pair 0 is assumed to be
+ white on black, but is actually whatever the terminal
+ implements before color is initialized. It cannot be
+ modified by the application.
+
+ If the color-pair was previously initialized, the screen
+ is refreshed and all occurrences of that color-pair are
changed to the new definition.
- As an extension, ncurses allows you to set color pair 0
- via the assume_default_colors routine, or to specify the
- use of default colors (color number -1) if you first
- invoke the use_default_colors routine.
-
- The init_color routine changes the definition of a color.
- It takes four arguments: the number of the color to be
- changed followed by three RGB values (for the amounts of
- red, green, and blue components). The value of the first
- argument must be between 0 and COLORS. (See the section
- Colors for the default color index.) Each of the last
- three arguments must be a value between 0 and 1000. When
- init_color is used, all occurrences of that color on the
+ As an extension, ncurses allows you to set color pair 0
+ via the assume_default_colors routine, or to specify the
+ use of default colors (color number -1) if you first in-
+ voke the use_default_colors routine.
+
+ The init_color routine changes the definition of a color.
+ It takes four arguments: the number of the color to be
+ changed followed by three RGB values (for the amounts of
+ red, green, and blue components). The value of the first
+ argument must be between 0 and COLORS. (See the section
+ Colors for the default color index.) Each of the last
+ three arguments must be a value between 0 and 1000. When
+ init_color is used, all occurrences of that color on the
screen immediately change to the new definition.
- The has_colors routine requires no arguments. It returns
- TRUE if the terminal can manipulate colors; otherwise, it
+ The has_colors routine requires no arguments. It returns
+ TRUE if the terminal can manipulate colors; otherwise, it
returns FALSE. This routine facilitates writing terminal-
- independent programs. For example, a programmer can use
- it to decide whether to use color or some other video
- attribute.
+ independent programs. For example, a programmer can use
+ it to decide whether to use color or some other video at-
+ tribute.
- The can_change_color routine requires no arguments. It
- returns TRUE if the terminal supports colors and can
- change their definitions; other, it returns FALSE. This
+ The can_change_color routine requires no arguments. It
+ returns TRUE if the terminal supports colors and can
+ change their definitions; other, it returns FALSE. This
routine facilitates writing terminal-independent programs.
The color_content routine gives programmers a way to find
@@ -149,9 +158,9 @@
about the amounts of red, green, and blue components in
the given color. The value of the first argument must be
between 0 and COLORS. The values that are stored at the
- addresses pointed to by the last three arguments are
- between 0 (no component) and 1000 (maximum amount of com-
- ponent).
+ addresses pointed to by the last three arguments are be-
+ tween 0 (no component) and 1000 (maximum amount of compo-
+ nent).
The pair_content routine allows programmers to find out
what colors a given color-pair consists of. It requires
@@ -186,12 +195,32 @@
an OK (SVr4 specifies only "an integer value other than
ERR") upon successful completion.
+ X/Open defines no error conditions. This implementation
+ will return ERR on attempts to use color values outside
+ the range 0 to COLORS-1 (except for the default colors ex-
+ tension), or use color pairs outside the range 0 to COL-
+ OR_PAIR-1. Color values used in init_color must be in the
+ range 0 to 1000. An error is returned from all functions
+ if the terminal has not been initialized. An error is re-
+ turned from secondary functions such as init_pair if
+ start_color was not called.
+
+ init_color
+ returns an error if the terminal does not sup-
+ port this feature, e.g., if the initial-
+ ize_color capability is absent from the termi-
+ nal description.
+
+ start_color
+ returns an error If the color table cannot be
+ allocated.
+
NOTES
In the ncurses implementation, there is a separate color
- activation flag, color palette, color pairs table, and
- associated COLORS and COLOR_PAIRS counts for each screen;
+ activation flag, color palette, color pairs table, and as-
+ sociated COLORS and COLOR_PAIRS counts for each screen;
the start_color function only affects the current screen.
The SVr4/XSI interface is not really designed with this in
mind, and historical implementations may use a single
@@ -225,14 +254,17 @@
mums for COLORS and COLOR_PAIRS.
The init_pair routine accepts negative values of fore-
- ground and background color to support the
- use_default_colors extension, but only if that routine has
- been first invoked.
+ ground and background color to support the use_de-
+ fault_colors extension, but only if that routine has been
+ first invoked.
The assumption that COLOR_BLACK is the default background
- color for all terminals can be modified using the
- assume_default_colors extension,
+ color for all terminals can be modified using the as-
+ sume_default_colors extension.
+ This implementation checks the pointers, e.g., for the
+ values returned by color_content and pair_content, and
+ will treat those as optional parameters when null.
@@ -242,34 +274,7 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ curs_color(3x)