include/wx/msw/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  16 #pragma interface "colour.h"
  17 #endif
  18 #include "wx/object.h"
  19
  20 // Colour
  21 class WXDLLEXPORT wxColour: public wxObject
  22 {
  23 public:
  24   // ctors
  25     // default
  26   wxColour();
  27     // from RGB
  28   wxColour( unsigned char red, unsigned char green, unsigned char blue );
  29   wxColour( unsigned long colRGB ) { Set(colRGB); }
  30
  31     // implicit conversion from the colour name
  32   wxColour( const wxString &colourName ) { InitFromName(colourName); }
  33   wxColour( const wxChar *colourName ) { InitFromName(colourName); }
  34
  35
  36     // copy ctors and assignment operators
  37   wxColour( const wxColour& col );
  38   wxColour& operator = ( const wxColour& col );
  39
  40     // dtor
  41   ~wxColour();
  42
  43   // to have the matching Create also for this class
  44   void Create( unsigned char red, unsigned char green, unsigned char blue )
  45   {     Set( red , green , blue ) ; }
  46
  47   // Set() functions
  48   void Set( unsigned char red, unsigned char green, unsigned char blue );
  49   void Set(unsigned long colRGB)
  50   {
  51     // we don't need to know sizeof(long) here because we assume that the three
  52     // least significant bytes contain the R, G and B values
  53     Set((unsigned char)colRGB,
  54         (unsigned char)(colRGB >> 8),
  55         (unsigned char)(colRGB >> 16));
  56   }
  57
  58   // accessors
  59   bool Ok() const {return m_isInit; }
  60
  61   // Let's remove this inelegant function
  62 #if WXWIN_COMPATIBILITY
  63   void Get(unsigned char *r, unsigned char *g, unsigned char *b) const;
  64 #endif
  65
  66   unsigned char Red() const { return m_red; }
  67   unsigned char Green() const { return m_green; }
  68   unsigned char Blue() const { return m_blue; }
  69
  70   // comparison
  71   bool operator==(const wxColour& colour) const
  72   {
  73     return m_isInit == colour.m_isInit &&
  74            m_red == colour.m_red &&
  75            m_green == colour.m_green &&
  76            m_blue == colour.m_blue;
  77   }
  78
  79   bool operator != (const wxColour& colour) const { return !(*this == colour); }
  80
  81   WXCOLORREF GetPixel() const { return m_pixel; };
  82
  83 public:
  84   WXCOLORREF m_pixel;
  85
  86 private:
  87   bool          m_isInit;
  88   unsigned char m_red;
  89   unsigned char m_blue;
  90   unsigned char m_green;
  91
  92   // helper func
  93   void InitFromName(const wxString& colourName);
  94
  95 private:
  96   DECLARE_DYNAMIC_CLASS(wxColour)
  97 };
  98
  99 #endif
 100         // _WX_COLOUR_H_