include/wx/mac/classic/colour.h

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