* src/LyXRC.{cpp,h}:

[lyx.git] / src / Color.h

diff --git a/src/Color.h b/src/Color.h
index ee3d88bf4292fcd215be8dc1525e2d7767f99cd3..d632bbce2f6fc48b9fbc3c740e55fab9d8f644fd 100644 (file)
--- a/src/Color.h
+++ b/src/Color.h
@@ -4,36 +4,105 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
+ * \author Jean-Marc Lasgouttes
  * \author Angus Leeming
+ * \author John Levon
+ * \author André Pönitz
+ * \author Martin Vermeer
  *
  * Full author contact details are available in file CREDITS.
  */
 
-/* structs RGBColor and HSVColor to enable simple conversion between
- * color spaces.
- */
+#ifndef LCOLOR_H
+#define LCOLOR_H
+
+#include "ColorCode.h"
 
-#ifndef COLOR_H
-#define COLOR_H
+#include "support/strfwd.h"
+
+#include <boost/scoped_ptr.hpp>
 
-#include <string>
 
 namespace lyx {
 
-struct RGBColor;
-/// returns a string of form #rrggbb, given an RGBColor struct
-std::string const X11hexname(RGBColor const & col);
+/**
+ * This is a stateless class.
+ *
+ * It has one basic purposes:
+ * To serve as a color-namespace container (the Color enum).
+ */
+/**
+ * \class Color
+ *
+ * A class holding color definitions and associated names for
+ * LaTeX, X11, the GUI, and LyX internally.
+ *
+ * A color can be one of the following kinds:
+ *
+ * - A real, predefined color, such as black, white, red or green.
+ * - A logical color, such as no color, inherit, math
+ */
+
+class Color
+// made copyable for same reasons as LyXRC was made copyable. See there for
+// explanation.
+{
+public:
+       ///
+       Color();
+       ///
+       Color(Color const &);
+       ///
+       ~Color();
+       ///
+       Color & operator=(Color);
 
-struct HSVColor {
-       double h;
-       double s;
-       double v;
-       HSVColor() : h(0.0), s(0.0), v(0.0) {}
-       HSVColor(double hue, double sat, double val)
-               : h(hue), s(sat), v(val) {}
-       HSVColor(RGBColor const &);
+       /** set the given LyX color to the color defined by the X11 name given
+        *  \returns true if successful.
+        */
+       bool setColor(ColorCode col, std::string const & x11name);
+
+       /** set the given LyX color to the color defined by the X11
+        *  name given \returns true if successful. A new color entry
+        *  is created if the color is unknown
+        */
+       bool setColor(std::string const & lyxname, std::string const & x11name);
+
+       /// Get the GUI name of \c color.
+       docstring const getGUIName(ColorCode c) const;
+
+       /// Get the X11 name of \c color.
+       std::string const getX11Name(ColorCode c) const;
+
+       /// Get the LaTeX name of \c color.
+       std::string const getLaTeXName(ColorCode c) const;
+
+       /// Get the LyX name of \c color.
+       std::string const getLyXName(ColorCode c) const;
+
+       /// \returns the ColorCode associated with the LyX name.
+       ColorCode getFromLyXName(std::string const & lyxname) const;
+       /// \returns the ColorCode associated with the LaTeX name.
+       ColorCode getFromLaTeXName(std::string const & latexname) const;
+private:
+       ///
+       void addColor(ColorCode c, std::string const & lyxname) const;
+       ///
+       class Pimpl;
+       ///
+       boost::scoped_ptr<Pimpl> pimpl_;
 };
 
+
+/// the current color definitions
+extern Color lcolor;
+/// the system color definitions
+extern Color system_lcolor;
+
+
 struct RGBColor {
        unsigned int r;
        unsigned int g;
@@ -41,21 +110,10 @@ struct RGBColor {
        RGBColor() : r(0), g(0), b(0) {}
        RGBColor(unsigned int red, unsigned int green, unsigned int blue)
                : r(red), g(green), b(blue) {}
-       RGBColor(HSVColor const &);
        /// \param x11hexname is of the form "#ffa071"
        RGBColor(std::string const & x11hexname);
 };
 
-struct NamedColor : public RGBColor {
-       std::string lyxname;
-       std::string guiname;
-       NamedColor() : RGBColor() {}
-       NamedColor(std::string const & lyx, std::string const & gui,
-                  RGBColor const & c)
-               : RGBColor(c), lyxname(lyx), guiname(gui) {}
-       RGBColor const & color() const { return *this; }
-};
-
 inline
 bool operator==(RGBColor const & c1, RGBColor const & c2)
 {
@@ -69,6 +127,9 @@ bool operator!=(RGBColor const & c1, RGBColor const & c2)
        return !(c1 == c2);
 }
 
+/// returns a string of form #rrggbb, given an RGBColor struct
+std::string const X11hexname(RGBColor const & col);
+
 } // namespace lyx
 
 #endif