src/ColorSet.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ColorSet.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author Matthias Ettrich
  10  * \author Jean-Marc Lasgouttes
  11  * \author Angus Leeming
  12  * \author John Levon
  13  * \author André Pönitz
  14  * \author Martin Vermeer
  15  *
  16  * Full author contact details are available in file CREDITS.
  17  */
  18
  19 #ifndef COLORSET_H
  20 #define COLORSET_H
  21
  22 #include "Color.h"
  23
  24 #include <map>
  25 #include <string>
  26
  27 namespace lyx {
  28
  29 /**
  30  * \class ColorSet
  31  *
  32  * A class holding color definitions and associated names for
  33  * LaTeX, X11, the GUI, and LyX internally.
  34  *
  35  * A color can be one of the following kinds:
  36  *
  37  * - A real, predefined color, such as black, white, red or green.
  38  * - A logical color, such as no color, inherit, math
  39  */
  40
  41
  42 // made copyable for same reasons as LyXRC was made copyable. See there for
  43 // explanation.
  44
  45 class ColorSet
  46 {
  47 public:
  48         ///
  49         ColorSet();
  50
  51         /** set the given LyX color to the color defined by the X11 hex name given
  52          *  \returns true if successful. The optional third argument passes
  53          *  a color for dark mode.
  54          */
  55         bool setColor(ColorCode col, std::string const & x11hexname,
  56                       std::string const & x11darkhexname = std::string());
  57
  58         /** set the given LyX color to the color defined by the X11
  59          *  hex name given \returns true if successful. A new color entry
  60          *  is created if the color is unknown. The optional third argument passes
  61          *  a color for dark mode.
  62          */
  63         bool setColor(std::string const & lyxname, std::string const & x11hexname,
  64                       std::string const & x11darkhexname = std::string());
  65
  66         /** set the given LyX color to a latexcolor if not yet defined
  67          *  \returns true if successful. A new color entry
  68          *  is created if the color is unknown.
  69          */
  70         bool setLaTeXName(std::string const & lyxname, std::string const & latexname);
  71
  72         /// Get the GUI name of \c color.
  73         docstring const getGUIName(ColorCode c) const;
  74
  75         /// Get the X11 hexname of \c color.
  76         std::string const getX11HexName(ColorCode c, bool const darkmode = false) const;
  77
  78         /// Get the X11 hexname of \c color.
  79         std::pair<std::string, std::string> const getAllX11HexNames(ColorCode c) const;
  80
  81         /// Get the LaTeX name of \c color.
  82         std::string const getLaTeXName(ColorCode c) const;
  83
  84         /// Get the LyX name of \c color.
  85         std::string const getLyXName(ColorCode c) const;
  86
  87         /// \returns the ColorCode associated with the LyX name.
  88         ColorCode getFromLyXName(std::string const & lyxname) const;
  89         /// \returns the ColorCode associated with the LaTeX name.
  90         ColorCode getFromLaTeXName(std::string const & latexname) const;
  91
  92 private:
  93         ///
  94         void addColor(ColorCode c, std::string const & lyxname);
  95         ///
  96         class Information {
  97         public:
  98                 /// the name as it appears in the GUI
  99                 std::string guiname;
 100                 /// the name used in LaTeX
 101                 std::string latexname;
 102                 /// the name for X11
 103                 std::string x11hexname;
 104                 /// matching X11 color for dark mode
 105                 std::string x11darkhexname;
 106                 /// the name for LyX
 107                 std::string lyxname;
 108         };
 109
 110         /// initialise a color entry
 111         struct ColorEntry;
 112         void fill(ColorEntry const & entry);
 113
 114         ///
 115         typedef std::map<ColorCode, Information> InfoTab;
 116         /// the table of color Information
 117         InfoTab infotab;
 118
 119         typedef std::map<std::string, ColorCode> Transform;
 120         /// the transform between LyX color name string and integer code.
 121         Transform lyxcolors;
 122         /// the transform between LaTeX color name string and integer code.
 123         Transform latexcolors;
 124 };
 125
 126
 127 /// the current color definitions
 128 extern ColorSet lcolor;
 129 /// the system color definitions
 130 extern ColorSet system_lcolor;
 131
 132 } // namespace lyx
 133
 134 #endif // COLORSET_H