7. Color Functions

7.1 color_number

Synopsis

color_number

Usage

Integer color_number (String obj);

Description

This function returns the object number associated with the string obj. Valid names for obj are as per set_color.

See Also

set_color, set_column_colors

See Also

WANT_SYNTAX_HIGHLIGHT, USE_ANSI_COLORS

7.2 set_color

Synopsis

Set the foreground and background colors of an object

Usage

set_color (String_Type obj, String_Type fg, String_Type bg

Description

This function sets the foreground and background colors of an object specified by the string obj to fg and bg. The exact values of the strings fg and bg are system dependent. For the X-Window system, they can be any string that the server understands, e.g., "SteelBlue". For other systems, the color must be one of the following:

   "black"            "gray"
   "red"              "brightred"
   "green"            "brightgreen"
   "brown"            "yellow"
   "blue"             "brightblue"
   "magenta"          "brightmagenta"
   "cyan"             "brightcyan"
   "lightgray"        "white"

One most terminals, the values in the second column have no affect when used as the background color.

The valid names for obj are:

   "normal"      Default foreground/background
   "status"      The status window line
   "region"      Highlighted Regions
   "cursor"      Text Cursor (X-Windows)
   "menu"        The menu bar
   "error"       Error messages
   "message"     Other messages
   "dollar"      Color of the indicator that text extends beyond the
                 boundary of the window.

If color syntax highlighting is enabled, the following object names are also meaningful:

   "number"      Numbers in C-mode and Equations in TeX-mode
   "delimiter"   Commas, semi-colons, etc...
   "keyword"     Language dependent
   "string"      Literal strings
   "comment"     Comments
   "operator"    Such as +, -, etc...
   "preprocess"  Preprocessor lines

If line attributes are available, then you may also specifiy the color of the hidden line indicator:

  "..."         Hidden line indicator

The color of the menu objects may be specified via

   "menu_char"       Menu item key-shortcut color
   "menu_shadow"     Color of the shadow
   "menu_selection"  Selected menu-item color
   "menu_popup"      Color of the popup box

See Also

set_color_esc, set_column_colors, set_color_object

See Also

WANT_SYNTAX_HIGHLIGHT, USE_ANSI_COLORS

7.3 set_color_esc

Synopsis

set_color_esc

Usage

Void set_color_esc (String object, String esc_seq);

Description

This function may be used to associate an escape sequence with an object. The escape sequence will be sent to the terminal prior to sending updating the object. It may be used on mono terminals to underline objects, etc... The object names are the same names used by the set_color function. Note: Care should be exercised when using this function. Also, one may need to experiment around a little to get escape sequences that work together.

See Also

set_color

7.4 set_color_object

Synopsis

set_color_object

Usage

Void set_color_object (Integer obj, String fg, String bg);

Description

Associate colors fg and bg with object obj. Valid values for obj are in the range 30 to 128. All other values are reserved. Values for the strings fg and bg are as given by the description for set_color.

See Also

set_column_colors, set_color

7.5 set_column_colors

Synopsis

set_column_colors

Usage

Void set_column_colors (Integer color, Integer c0, Integer c1);

Description

This function associates a color with columns c0 through c1 in the current buffer. That is, if there is no syntax highlighting already defined for the current buffer, when the current buffer is displayed, columns c0 through c1 will be displayed with the attributes of the color object. The parameters c0 and c1 are restricted to the range 1 through SCREEN_WIDTH. Use the function set_color_object to assign attributes to the color object.

See Also

set_color_object