X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLColor.h;h=b9595e393f061cf3efe547bf27498bed369689df;hb=6688a55908e69456ea774cea04f4b318e9b2b64a;hp=40c656db88c65fe42582df6c5fbf49f94a96facc;hpb=627f2c70fa6d5c75ef4dfe4e7252adc7c141e6f4;p=lyx.git diff --git a/src/LColor.h b/src/LColor.h index 40c656db88..b9595e393f 100644 --- a/src/LColor.h +++ b/src/LColor.h @@ -23,13 +23,11 @@ #include /** - 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 * @@ -191,49 +189,42 @@ public: /// ~LColor(); /// - void operator=(LColor const &); + LColor & operator=(LColor); - /// - 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, 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 + /// Get the GUI name of \c color. std::string const getGUIName(LColor::color c) const; - /// - std::string const getGUIName(std::string const & s) 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 + /// \returns the LColor::color associated with 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_; }; @@ -243,15 +234,15 @@ private: * 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(-1)) {} LColor_color(LColor::color val) : val_(val) {} - operator LColor::color() const{ return val_; } + operator LColor::color() const{ return val_; } };