#ifndef LCOLOR_H
#define LCOLOR_H
-#include <boost/scoped_ptr.hpp>
-#include <string>
+#include "support/docstring.h"
-/**
- This is a stateless class.
+#include <boost/scoped_ptr.hpp>
- It has one basic purposes:
- To serve as a color-namespace container (the Color enum).
+namespace lyx {
- */
+/**
+ * This is a stateless class.
+ *
+ * It has one basic purposes:
+ * To serve as a color-namespace container (the Color enum).
+ */
/**
* \class LColor
*
greyedout,
/// Background color of greyedout inset
greyedoutbg,
-
+ /// Shaded box background
+ shadedbg,
/// Color for the depth bars in the margin
depthbar,
pagebreak,
// FIXME: why are the next four separate ??
- /// Color used for top of boxes
- top,
- /// Color used for bottom of boxes
- bottom,
- /// Color used for left side of boxes
- left,
- /// Color used for right side of boxes
- right,
+ /// Color used for button frame
+ buttonframe,
/// Color used for bottom background
buttonbg,
+ /// Color used for buttom under focus
+ buttonhoverbg,
// Logical attributes
///
~LColor();
///
- void operator=(LColor const &);
+ LColor & operator=(LColor);
- ///
- void LColor::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, std::string const & x11name);
- /// set the given LyX color to the color defined by the X11 name given
+ /** 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);
+
+ /** 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 GUI name of color
- std::string const getGUIName(LColor::color c) const;
- ///
- std::string const getGUIName(std::string const & s) const;
+ /// Get the GUI name of \c color.
+ docstring const getGUIName(LColor::color c) const;
- /// Get X11 name of color
+ /// Get the X11 name of \c color.
std::string const getX11Name(LColor::color c) const;
- ///
- std::string const getX11Name(std::string const & s) const;
- /// Get LaTeX name of color
+ /// Get the LaTeX name of \c color.
std::string const getLaTeXName(LColor::color c) const;
- ///
- std::string const getLaTeXName(std::string const & s) const;
- /// Get LyX name of color
+ /// Get the LyX name of \c color.
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(std::string const & guiname) const;
- /// get the color from the LyX name
+ /// \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;
///
boost::scoped_ptr<Pimpl> pimpl_;
};
* passed as a function argument without having to expose LColor.h.
*/
class LColor_color {
- LColor::color val_;
+ LColor::color val_;
public:
- /** The default constructor is nasty,
+ /** 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_; }
+ operator LColor::color() const{ return val_; }
};
/// the system color definitions
extern LColor system_lcolor;
+
+} // namespace lyx
+
#endif