X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLColor.h;h=b9595e393f061cf3efe547bf27498bed369689df;hb=6688a55908e69456ea774cea04f4b318e9b2b64a;hp=43405264c94b5ed4924062c21450a77516fbb34b;hpb=69cb723040a9c6a045f1eb86e3ccab7e0b2838e5;p=lyx.git

diff --git a/src/LColor.h b/src/LColor.h
index 43405264c9..b9595e393f 100644
--- a/src/LColor.h
+++ b/src/LColor.h
@@ -1,26 +1,33 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- *           LyX, The Document Processor
+/**
+ * \file LColor.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *	    Copyright 1998-2001 The LyX Team
+ * \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.
+ */
 
 #ifndef LCOLOR_H
 #define LCOLOR_H
 
-#include "LString.h"
+#include <boost/scoped_ptr.hpp>
+#include <string>
 
 /**
-  This is a stateless class.
-
-  It has one basic purposes:
-  To serve as a color-namespace container (the Color enum).
-
-
-  */
+ * This is a stateless class.
+ *
+ * It has one basic purposes:
+ * To serve as a color-namespace container (the Color enum).
+ */
 /**
  * \class LColor
  *
@@ -33,7 +40,7 @@
  * - A logical color, such as no color, inherit, math
  */
 
-class LColor 
+class LColor
 // made copyable for same reasons as LyXRC was made copyable. See there for
 // explanation.
 {
@@ -78,6 +85,14 @@ public:
 		note,
 		/// Background color of notes
 		notebg,
+		/// Text color for comments
+		comment,
+		/// Background color of comments
+		commentbg,
+		/// Text color for greyedout inset
+		greyedout,
+		/// Background color of greyedout inset
+		greyedoutbg,
 
 
 		/// Color for the depth bars in the margin
@@ -166,6 +181,7 @@ public:
 		ignore
 	};
 
+
 	///
 	LColor();
 	///
@@ -173,35 +189,63 @@ public:
 	///
 	~LColor();
 	///
-	void operator=(LColor const &);
-	/// set the given LyX color to the color defined by the X11 name given
-	void setColor(LColor::color col, string const & x11name);
-	/// set the given LyX color to the color defined by the X11 name given
-	bool setColor(string const & lyxname, string const & x11name);
+	LColor & operator=(LColor);
+
+	/** set the given LyX color to the color defined by the X11 name given
+	 *  \returns true if successful.
+	 */
+	bool setColor(LColor::color col, std::string const & x11name);
 
-	/// Get GUI name of color
-	string const getGUIName(LColor::color c) const;
+	/** 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 X11 name of color
-	string const getX11Name(LColor::color c) const;
+	/// Get the GUI name of \c color.
+	std::string const getGUIName(LColor::color c) const;
 
-	/// Get LaTeX name of color
-	string const getLaTeXName(LColor::color c) const;
+	/// Get the X11 name of \c color.
+	std::string const getX11Name(LColor::color c) const;
 
-	/// Get LyX name of color
-	string const getLyXName(LColor::color c) const;
+	/// Get the LaTeX name of \c color.
+	std::string const getLaTeXName(LColor::color c) const;
 
-	/// get the color from the GUI name
-	LColor::color getFromGUIName(string const & guiname) const;
-	/// get the color from the LyX name
-	LColor::color getFromLyXName(string const & lyxname) const;
+	/// Get the LyX name of \c color.
+	std::string const getLyXName(LColor::color c) const;
+
+	/// \returns the LColor::color associated with the GUI name.
+	LColor::color getFromGUIName(std::string const & guiname) const;
+	/// \returns the LColor::color associated with the LyX name.
+	LColor::color getFromLyXName(std::string const & lyxname) const;
+	/// \returns the LColor::color associated with the LaTeX name.
+	LColor::color getFromLaTeXName(std::string const & latexname) const;
 private:
 	///
-	struct Pimpl;
+	void addColor(LColor::color c, std::string const & lyxname) const;
+	///
+	class Pimpl;
 	///
-	Pimpl * pimpl_;
+	boost::scoped_ptr<Pimpl> pimpl_;
 };
 
+
+/** \c LColor_color is a wrapper for LColor::color. It can be forward-declared and
+ *  passed as a function argument without having to expose LColor.h.
+ */
+class LColor_color {
+	LColor::color val_;
+public:
+	/** The default constructor is nasty,
+	 *  but allows us to use LColor_color in STL containers.
+	 */
+	LColor_color() : val_(static_cast<LColor::color>(-1)) {}
+
+	LColor_color(LColor::color val) : val_(val) {}
+	operator LColor::color() const{ return val_; }
+};
+
+
 /// the current color definitions
 extern LColor lcolor;
 /// the system color definitions