4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
9 * \author Matthias Ettrich
10 * \author Jean-Marc Lasgouttes
11 * \author Angus Leeming
13 * \author André Pönitz
14 * \author Martin Vermeer
16 * Full author contact details are available in file CREDITS.
22 #include "ColorCode.h"
24 #include "support/strfwd.h"
34 * A class holding color definitions and associated names for
35 * LaTeX, X11, the GUI, and LyX internally.
37 * A color can be one of the following kinds:
39 * - A real, predefined color, such as black, white, red or green.
40 * - A logical color, such as no color, inherit, math
44 // made copyable for same reasons as LyXRC was made copyable. See there for
53 /** set the given LyX color to the color defined by the X11 name given
54 * \returns true if successful.
56 bool setColor(ColorCode col, std::string const & x11name);
58 /** set the given LyX color to the color defined by the X11
59 * name given \returns true if successful. A new color entry
60 * is created if the color is unknown
62 bool setColor(std::string const & lyxname, std::string const & x11name);
64 /// Get the GUI name of \c color.
65 docstring const getGUIName(ColorCode c) const;
67 /// Get the X11 name of \c color.
68 std::string const getX11Name(ColorCode c) const;
70 /// Get the LaTeX name of \c color.
71 std::string const getLaTeXName(ColorCode c) const;
73 /// Get the LyX name of \c color.
74 std::string const getLyXName(ColorCode c) const;
76 /// \returns the ColorCode associated with the LyX name.
77 ColorCode getFromLyXName(std::string const & lyxname) const;
78 /// \returns the ColorCode associated with the LaTeX name.
79 ColorCode getFromLaTeXName(std::string const & latexname) const;
83 void addColor(ColorCode c, std::string const & lyxname);
87 /// the name as it appears in the GUI
89 /// the name used in LaTeX
90 std::string latexname;
97 /// initialise a color entry
99 void fill(ColorEntry const & entry);
102 typedef std::map<ColorCode, Information> InfoTab;
103 /// the table of color Information
106 typedef std::map<std::string, ColorCode> Transform;
107 /// the transform between LyX color name string and integer code.
109 /// the transform between LaTeX color name string and integer code.
110 Transform latexcolors;
114 /// the current color definitions
115 extern ColorSet lcolor;
116 /// the system color definitions
117 extern ColorSet system_lcolor;
119 std::string const X11hexname(RGBColor const & col);
120 RGBColor rgbFromHexName(std::string const & x11hexname);