include/wx/mac/classic/colour.h

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