src/frontends/xforms/Color.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Color.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 /* structs RGBColor and HSVColor to enable simple conversion between
  13  * color spaces.
  14  */
  15
  16 #ifndef COLOR_H
  17 #define COLOR_H
  18
  19
  20 #include "support/std_string.h"
  21 #include "LColor.h"
  22
  23 /** Given col, fills r, g, b in the range 0-255.
  24     The function returns true if successful.
  25     It returns false on failure and sets r, g, b to 0. */
  26 bool getRGBColor(LColor::color col,
  27                  unsigned int & r, unsigned int & g, unsigned int & b);
  28
  29 struct RGBColor;
  30 /// returns a string of form #rrggbb, given an RGBColor struct
  31 string const X11hexname(RGBColor const & col);
  32
  33 struct HSVColor {
  34         double h;
  35         double s;
  36         double v;
  37         HSVColor() : h(0.0), s(0.0), v(0.0) {}
  38         HSVColor(double hue, double sat, double val)
  39                 : h(hue), s(sat), v(val) {}
  40         HSVColor(RGBColor const &);
  41 };
  42
  43 struct RGBColor {
  44         unsigned int r;
  45         unsigned int g;
  46         unsigned int b;
  47         RGBColor() : r(0), g(0), b(0) {}
  48         RGBColor(unsigned int red, unsigned int green, unsigned int blue)
  49                 : r(red), g(green), b(blue) {}
  50         RGBColor(HSVColor const &);
  51         /// \param x11hexname is of the form "#ffa071"
  52         RGBColor(string const & x11hexname);
  53 };
  54
  55 struct NamedColor : public RGBColor {
  56         string name;
  57         NamedColor() : RGBColor() {}
  58         NamedColor(string const & n, RGBColor const & c)
  59                 : RGBColor(c), name(n) {}
  60         RGBColor const & color() const { return *this; }
  61         string const & getname() const { return name; }
  62 };
  63
  64 inline
  65 bool operator==(RGBColor const & c1, RGBColor const & c2)
  66 {
  67         return (c1.r == c2.r && c1.g == c2.g && c1.b == c2.b);
  68 }
  69
  70
  71 inline
  72 bool operator!=(RGBColor const & c1, RGBColor const & c2)
  73 {
  74         return !(c1 == c2);
  75 }
  76
  77 #endif