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