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
81 /// Text color for comments
83 /// Background color of comments
85 /// Text color for greyedout inset
87 /// Background color of greyedout inset
91 /// Color for the depth bars in the margin
93 /// Color for marking foreign language words
96 /// Text color for command insets
98 /// Background color for command insets
100 /// Frame color for command insets
103 /// Special chars text color
106 /// Graphics inset background color
108 /// Math inset text color
110 /// Math inset background color
112 /// Macro math inset background color
114 /// Math inset frame color
119 /// caption frame color
122 /// collapsable insets text
124 /// collapsable insets frame
127 /// Inset marker background color
129 /// Inset marker frame color
132 /// Error box text color
136 /// Added space colour
138 /// Appendix marker color
146 /// Top and bottom line color
152 /// Bottom area color
157 // FIXME: why are the next four separate ??
158 /// Color used for top of boxes
160 /// Color used for bottom of boxes
162 /// Color used for left side of boxes
164 /// Color used for right side of boxes
166 /// Color used for bottom background
169 // Logical attributes
171 /// Color is inherited
173 /// For ignoring updates of a color
180 LColor(LColor const &);
184 void operator=(LColor const &);
185 /// set the given LyX color to the color defined by the X11 name given
186 void setColor(LColor::color col, string const & x11name);
187 /// set the given LyX color to the color defined by the X11 name given
188 bool setColor(string const & lyxname, string const & x11name);
190 /// Get GUI name of color
191 string const getGUIName(LColor::color c) const;
193 /// Get X11 name of color
194 string const getX11Name(LColor::color c) const;
196 /// Get LaTeX name of color
197 string const getLaTeXName(LColor::color c) const;
199 /// Get LyX name of color
200 string const getLyXName(LColor::color c) const;
202 /// get the color from the GUI name
203 LColor::color getFromGUIName(string const & guiname) const;
204 /// get the color from the LyX name
205 LColor::color getFromLyXName(string const & lyxname) const;
213 /// the current color definitions
214 extern LColor lcolor;
215 /// the system color definitions
216 extern LColor system_lcolor;