include/wx/mac/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        colour.h
   3 // Purpose:     wxColour class
   4 // Author:      AUTHOR
   5 // Modified by:
   6 // Created:     ??/??/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) AUTHOR
   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 #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();
  29     // from RGB
  30   wxColour( unsigned char red, unsigned char green, unsigned char blue );
  31   wxColour( unsigned long colRGB )
  32       : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
  33       { Set(colRGB); }
  34
  35     // implicit conversion from the colour name
  36   wxColour( const wxString &colourName )
  37       : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
  38       { InitFromName(colourName); }
  39   wxColour( const char *colourName )
  40       : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
  41       { InitFromName(colourName); }
  42
  43     // copy ctors and assignment operators
  44   wxColour( const wxColour& col );
  45   wxColour( const wxColour* col );
  46   wxColour& operator = ( const wxColour& col );
  47
  48     // dtor
  49   ~wxColour();
  50
  51   // Set() functions
  52   void Set( unsigned char red, unsigned char green, unsigned char blue );
  53   void Set( unsigned long colRGB )
  54   {
  55     // we don't need to know sizeof(long) here because we assume that the three
  56     // least significant bytes contain the R, G and B values
  57     Set((unsigned char)colRGB,
  58         (unsigned char)(colRGB >> 8),
  59         (unsigned char)(colRGB >> 16));
  60   }
  61
  62   // accessors
  63   bool Ok() const {return m_isInit; }
  64
  65   // Let's remove this inelegant function
  66 #if WXWIN_COMPATIBILITY
  67   void Get(unsigned char *r, unsigned char *g, unsigned char *b) const;
  68 #endif
  69
  70   unsigned char Red() const { return m_red; }
  71   unsigned char Green() const { return m_green; }
  72   unsigned char Blue() const { return m_blue; }
  73
  74   // comparison
  75   bool operator == (const wxColour& colour) const
  76   {
  77     return (m_isInit == colour.m_isInit &&
  78             m_red == colour.m_red &&
  79             m_green == colour.m_green &&
  80             m_blue == colour.m_blue);
  81   }
  82   bool operator != (const wxColour& colour) { return !(*this == colour); }
  83
  84   void InitFromName(const wxString& col);
  85
  86   const WXCOLORREF& GetPixel() const { return m_pixel; };
  87
  88 private:
  89   bool          m_isInit;
  90   unsigned char m_red;
  91   unsigned char m_blue;
  92   unsigned char m_green;
  93
  94 public:
  95   WXCOLORREF m_pixel ;
  96   void Set( const WXCOLORREF* color ) ;
  97
  98 private:
  99   DECLARE_DYNAMIC_CLASS(wxColour)
 100 };
 101
 102 #endif
 103   // _WX_COLOUR_H_