X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLColor.h;h=c6bf6cebf7c47a754bd67411c3643b61157cd712;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=6e481cf6744272c0031bc82f7b69441902431e50;hpb=a6ccea4f21c3da972fb3577ab07404da83f0a223;p=lyx.git diff --git a/src/LColor.h b/src/LColor.h index 6e481cf674..c6bf6cebf7 100644 --- a/src/LColor.h +++ b/src/LColor.h @@ -19,17 +19,18 @@ #ifndef LCOLOR_H #define LCOLOR_H -#include "support/std_string.h" #include +#include -/** - This is a stateless class. - - 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 * @@ -95,7 +96,8 @@ public: greyedout, /// Background color of greyedout inset greyedoutbg, - + /// Shaded box background + shadedbg, /// Color for the depth bars in the margin depthbar, @@ -191,67 +193,60 @@ public: /// ~LColor(); /// - void operator=(LColor const &); + LColor & operator=(LColor); - /// - void LColor::fill(LColor::color c, - string const & lyxname, - string const & x11name = string(), - string const & latexname = string(), - string const & guiname = string()); - - /// 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); - - /// Get GUI name of color - string const getGUIName(LColor::color c) const; - /// - string const getGUIName(string const & s) const; + /** 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 X11 name of color - string const getX11Name(LColor::color c) const; - /// - string const getX11Name(string const & s) 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 LaTeX name of color - string const getLaTeXName(LColor::color c) const; - /// - string const getLaTeXName(string const & s) const; + /// Get the GUI name of \c color. + std::string const getGUIName(LColor::color c) const; - /// Get LyX name of color - string const getLyXName(LColor::color c) const; - /// (string-to-string version not needed as it is identity) + /// Get the X11 name of \c color. + std::string const getX11Name(LColor::color c) const; - /// - size_t size() 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; /// boost::scoped_ptr pimpl_; }; -/** \c EnumLColor is a wrapper for LColor::color. It can be forward-declared and +/** \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 EnumLColor { - LColor::color val_; +class LColor_color { + LColor::color val_; public: - /** The default constructor is nasty, - * but allows us to use EnumLColor in STL containers. + /** The default constructor is nasty, + * but allows us to use LColor_color in STL containers. */ - EnumLColor() : val_(static_cast(-1)) {} + LColor_color() : val_(static_cast(-1)) {} - EnumLColor(LColor::color val) : val_(val) {} - operator LColor::color() const{ return val_; } + LColor_color(LColor::color val) : val_(val) {} + operator LColor::color() const{ return val_; } }; @@ -260,4 +255,7 @@ extern LColor lcolor; /// the system color definitions extern LColor system_lcolor; + +} // namespace lyx + #endif