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