1\function{add_color_object} 2\synopsis{Return the object number associated with "obj"} 3\usage{add_color_object (String_Type name)} 4\description 5 This function creates a new color object with a specified name. See 6 the \var{set_color} documentation for pre-defined color objects. 7\seealso{set_color, get_color, color_number} 8\done 9 10\function{color_number} 11\synopsis{Return the object number associated with "obj"} 12\usage{Integer color_number (String obj)} 13\description 14 This function returns the object number associated with the 15 string \var{obj}. Valid names for \var{obj} are as per \var{set_color}. 16\seealso{set_color, set_column_colors} 17\seealso{WANT_SYNTAX_HIGHLIGHT, USE_ANSI_COLORS} 18\done 19 20\function{get_color} 21\synopsis{Return the foreground and background color of an object} 22\usage{(String_Type fg, String_Type bg) = get_color (String_Type name)} 23\description 24 This function returns the foreground and background colors of the 25 specified color object. 26\seealso{set_color, color_number, add_color_object} 27\done 28 29\function{set_color} 30\synopsis{Set fore- and background colors of an object} 31\usage{set_color (String_Type obj, String_Type fg, String_Type bg)} 32\description 33 This function sets the foreground and background colors of an object 34 specified by the string \var{obj} to \var{fg} and \var{bg}. The exact values of 35 the strings \var{fg} and \var{bg} are system dependent. For the X-Window 36 system, they can be any string that the server understands, e.g., 37 \var{"SteelBlue"}. For other systems, the color must be one of the 38 following: 39#v+ 40 "black" "gray" 41 "red" "brightred" 42 "green" "brightgreen" 43 "brown" "yellow" 44 "blue" "brightblue" 45 "magenta" "brightmagenta" 46 "cyan" "brightcyan" 47 "lightgray" "white" 48 "default" 49#v- 50 One most terminals, the values in the second column have no affect 51 when used as the background color. 52 53 Using "default" as a foreground or background color instructs the 54 editor to tell the terminal to use the default foreground and 55 background colors of the window. If you use a terminal that uses a 56 transparant background, then you need to specify "default" as the 57 background color. Not all terminals support the notion of the 58 "default" color. 59 60 The valid names for \var{obj} are: 61#v+ 62 "normal" Default foreground/background 63 "status" The status window line 64 "region" Highlighted Regions 65 "cursor" Text Cursor (X-Windows) 66 "cursorovr" Text Cursor in overwrite mode (X-Windows) 67 "menu" The menu bar 68 "error" Error messages 69 "message" Other messages 70 "dollar" Color of the indicator that text extends beyond the 71 boundary of the window. 72 "linenum" Line number field 73#v- 74 If color syntax highlighting is enabled, the following object names 75 are also meaningful: 76#v+ 77 "number" Numbers in C-mode and Equations in TeX-mode 78 "delimiter" Commas, semi-colons, etc... 79 "keyword" Language dependent 80 "keyword1" Language dependent 81 "keyword2" Language dependent 82 "keyword3" Language dependent 83 "keyword4" Language dependent 84 "keyword5" Language dependent 85 "keyword6" Language dependent 86 "keyword7" Language dependent 87 "keyword8" Language dependent 88 "keyword9" Language dependent 89 "string" Literal strings 90 "comment" Comments 91 "operator" Such as +, -, etc... 92 "preprocess" Preprocessor lines 93 "tab" 94 "trailing_whitespace" 95 "html" <html> and '<' syntax objects. 96#v- 97 If line attributes are available, then you may also specifiy the color 98 of the hidden line indicator: 99#v+ 100 "..." Hidden line indicator 101#v- 102 The color of the menu objects may be specified via 103#v+ 104 "menu_char" Menu item key-shortcut color 105 "menu_shadow" Color of the shadow 106 "menu_selection" Selected menu-item color 107 "menu_popup" Color of the popup box 108 "menu_selection_char" Selected menu item key-shortcut color 109#v- 110 Xjed defines the following objects: 111#v+ 112 "mouse" Mouse cursor color 113 "border" Window borde color 114#v- 115\seealso{define_syntax, set_color_esc, set_column_colors, set_color_object} 116\seealso{WANT_SYNTAX_HIGHLIGHT, USE_ANSI_COLORS} 117\done 118 119\function{set_color_esc} 120\synopsis{associate an escape sequence with an object} 121\usage{Void set_color_esc (String object, String esc_seq)} 122\description 123 This function may be used to associate an escape sequence with an 124 object. The escape sequence will be sent to the terminal prior to 125 sending updating the object. It may be used on mono terminals to 126 underline objects, etc... The object names are the same names used by 127 the \var{set_color} function. 128 Note: Care should be exercised when using 129 this function. Also, one may need to experiment around a little to 130 get escape sequences that work together. 131\seealso{set_color} 132\done 133 134\function{set_color_object} 135\synopsis{Associate colors "fg" and "bg" with object "obj"} 136\usage{Void set_color_object (Integer obj, String fg, String bg)} 137\description 138 Associate colors \var{fg} and \var{bg} with object \var{obj}. Valid values for \var{obj} 139 are in the range 30 to 128. All other values are reserved. Values for 140 the strings \var{fg} and \var{bg} are as given by the description for \var{set_color}. 141\seealso{set_column_colors, set_color} 142\done 143 144\function{set_column_colors} 145\synopsis{Associate a color with columns \var{c0} through \var{c1}} 146\usage{Void set_column_colors (Integer color, Integer c0, Integer c1)} 147\description 148 This function associates a color with columns \exmp{c0} through \var{c1} in the 149 current buffer. That is, if there is no syntax highlighting already 150 defined for the current buffer, when the current buffer is displayed, 151 columns \exmp{c0} through \var{c1} will be displayed with the attributes of the 152 \var{color} object. The parameters \exmp{c0} and \var{c1} are restricted to the range 153 1 through \var{SCREEN_WIDTH}. Use the function \var{set_color_object} to assign 154 attributes to the \var{color} object. 155\seealso{set_color_object} 156\done 157 158