// -*- 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.
* - 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.
{
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
ignore
};
+
///
LColor();
///
~LColor();
///
void operator=(LColor const &);
+
+ ///
+ void fill(LColor::color c,
+ std::string const & lyxname,
+ std::string const & x11name = std::string(),
+ std::string const & latexname = std::string(),
+ std::string const & guiname = std::string());
+
/// set the given LyX color to the color defined by the X11 name given
- void setColor(LColor::color col, string const & x11name);
+ void setColor(LColor::color col, std::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);
+ bool setColor(std::string const & lyxname, std::string const & x11name);
/// Get GUI name of color
- string const getGUIName(LColor::color c) const;
+ std::string const getGUIName(LColor::color c) const;
+ ///
+ std::string const getGUIName(std::string const & s) const;
/// Get X11 name of color
- string const getX11Name(LColor::color c) const;
+ std::string const getX11Name(LColor::color c) const;
+ ///
+ std::string const getX11Name(std::string const & s) const;
/// Get LaTeX name of color
- string const getLaTeXName(LColor::color c) const;
+ std::string const getLaTeXName(LColor::color c) const;
+ ///
+ std::string const getLaTeXName(std::string const & s) const;
/// Get LyX name of color
- string const getLyXName(LColor::color c) const;
+ std::string const getLyXName(LColor::color c) const;
+ /// (string-to-string version not needed as it is identity)
+
+ ///
+ size_t size() const;
/// get the color from the GUI name
- LColor::color getFromGUIName(string const & guiname) const;
+ LColor::color getFromGUIName(std::string const & guiname) const;
/// get the color from the LyX name
- LColor::color getFromLyXName(string const & lyxname) const;
+ LColor::color getFromLyXName(std::string const & lyxname) const;
private:
///
struct 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