2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1998-2001 The LyX Team
9 *======================================================*/
17 This is a stateless class.
19 It has one basic purposes:
20 To serve as a color-namespace container (the Color enum).
27 * A class holding color definitions and associated names for
28 * LaTeX, X11, the GUI, and LyX internally.
30 * A color can be one of the following kinds:
32 * - A real, predefined color, such as black, white, red or green.
33 * - A logical color, such as no color, inherit, math
37 // made copyable for same reasons as LyXRC was made copyable. See there for
41 /// Names of colors, including all logical colors
43 /// No particular color---clear or default
45 /// The different text colors
62 // Needed interface colors
70 /// Background color of selected text
72 /// Text color in LaTeX mode
74 /// The color used for previews
77 /// Text color for notes
79 /// Background color of notes
83 /// Color for the depth bars in the margin
85 /// Color for marking foreign language words
88 /// Text color for command insets
90 /// Background color for command insets
92 /// Frame color for command insets
95 /// Special chars text color
98 /// Graphics inset background color
100 /// Math inset text color
102 /// Math inset background color
104 /// Macro math inset background color
106 /// Math inset frame color
111 /// caption frame color
114 /// collapsable insets text
116 /// collapsable insets frame
119 /// Inset marker background color
121 /// Inset marker frame color
124 /// Error box text color
128 /// Added space colour
130 /// Appendix marker color
138 /// Top and bottom line color
144 /// Bottom area color
149 // FIXME: why are the next four separate ??
150 /// Color used for top of boxes
152 /// Color used for bottom of boxes
154 /// Color used for left side of boxes
156 /// Color used for right side of boxes
158 /// Color used for bottom background
161 // Logical attributes
163 /// Color is inherited
165 /// For ignoring updates of a color
172 LColor(LColor const &);
176 void operator=(LColor const &);
177 /// set the given LyX color to the color defined by the X11 name given
178 void setColor(LColor::color col, string const & x11name);
179 /// set the given LyX color to the color defined by the X11 name given
180 bool setColor(string const & lyxname, string const & x11name);
182 /// Get GUI name of color
183 string const getGUIName(LColor::color c) const;
185 /// Get X11 name of color
186 string const getX11Name(LColor::color c) const;
188 /// Get LaTeX name of color
189 string const getLaTeXName(LColor::color c) const;
191 /// Get LyX name of color
192 string const getLyXName(LColor::color c) const;
194 /// get the color from the GUI name
195 LColor::color getFromGUIName(string const & guiname) const;
196 /// get the color from the LyX name
197 LColor::color getFromLyXName(string const & lyxname) const;
205 /// the current color definitions
206 extern LColor lcolor;
207 /// the system color definitions
208 extern LColor system_lcolor;