include/wx/mgl/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mgl/colour.h
   3 // Purpose:     wxColour class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_COLOUR_H_
  13 #define _WX_COLOUR_H_
  14
  15 #include "wx/object.h"
  16
  17 // Colour
  18 class WXDLLEXPORT wxColour: public wxObject
  19 {
  20 public:
  21     // constructors
  22     // ------------
  23
  24     // default
  25     wxColour();
  26
  27     // from separate RGB
  28     wxColour(unsigned char red, unsigned char green, unsigned char blue)
  29         { Set(red, green, blue); }
  30
  31     // from packed RGB
  32     wxColour(unsigned long colRGB) { Set(colRGB); }
  33
  34     // implicit conversion from the colour name
  35     wxColour(const wxString &colourName) { InitFromName(colourName); }
  36     wxColour(const char *colourName) { InitFromName(colourName); }
  37
  38
  39     // copy ctors and assignment operators
  40     wxColour(const wxColour& col);
  41     wxColour& operator = (const wxColour& col);
  42
  43     // dtor
  44     ~wxColour();
  45
  46     // Set() functions
  47     void Set(unsigned char red, unsigned char green, unsigned char blue);
  48     void Set(unsigned long colRGB)
  49     {
  50         // we don't need to know sizeof(long) here because we assume that the three
  51         // least significant bytes contain the R, G and B values
  52         Set((unsigned char)colRGB,
  53             (unsigned char)(colRGB >> 8),
  54             (unsigned char)(colRGB >> 16));
  55     }
  56
  57     // accessors
  58     bool Ok() const { return m_isInit; }
  59
  60     unsigned char Red() const { return m_red; }
  61     unsigned char Green() const { return m_green; }
  62     unsigned char Blue() const { return m_blue; }
  63
  64     // comparison
  65     bool operator == (const wxColour& colour) const
  66     {
  67         return (m_red == colour.m_red &&
  68                 m_green == colour.m_green &&
  69                 m_blue == colour.m_blue &&
  70                 m_isInit == colour.m_isInit);
  71     }
  72     bool operator != (const wxColour& colour) const { return !(*this == colour); }
  73
  74     void InitFromName(const wxString& colourName);
  75
  76 protected:
  77
  78     // Helper function
  79     void Init();
  80
  81 private:
  82     bool m_isInit;
  83     unsigned char m_red;
  84     unsigned char m_blue;
  85     unsigned char m_green;
  86
  87 private:
  88     DECLARE_DYNAMIC_CLASS(wxColour)
  89 };
  90
  91 #endif
  92         // _WX_COLOUR_H_