include/wx/motif/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        colour.h
   3 // Purpose:     wxColour class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   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 #include "wx/object.h"
  20 #include "wx/string.h"
  21
  22 // Colour
  23 class WXDLLEXPORT wxColour: public wxObject
  24 {
  25   DECLARE_DYNAMIC_CLASS(wxColour)
  26 public:
  27   wxColour();
  28   wxColour(unsigned char r, unsigned char g, unsigned char b);
  29   wxColour(unsigned long colRGB) { Set(colRGB); }
  30   wxColour(const wxColour& col);
  31   wxColour(const wxString& col);
  32   ~wxColour() ;
  33   wxColour& operator =(const wxColour& src) ;
  34   wxColour& operator =(const wxString& src) ;
  35   inline int Ok() const { return (m_isInit) ; }
  36
  37   void Set(unsigned char r, unsigned char g, unsigned char b);
  38   void Set(unsigned long colRGB)
  39   {
  40     // we don't need to know sizeof(long) here because we assume that the three
  41     // least significant bytes contain the R, G and B values
  42     Set((unsigned char)colRGB,
  43         (unsigned char)(colRGB >> 8),
  44         (unsigned char)(colRGB >> 16));
  45   }
  46
  47   inline unsigned char Red() const { return m_red; }
  48   inline unsigned char Green() const { return m_green; }
  49   inline unsigned char Blue() const { return m_blue; }
  50
  51   inline bool operator == (const wxColour& colour) { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); }
  52
  53   inline bool operator != (const wxColour& colour) { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); }
  54
  55   inline int GetPixel() const { return m_pixel; };
  56   inline void SetPixel(int pixel) { m_pixel = pixel; m_isInit = TRUE; };
  57
  58   // Allocate a colour, or nearest colour, using the given display.
  59   // If realloc is TRUE, ignore the existing pixel, otherwise just return
  60   // the existing one.
  61   // Returns the allocated pixel.
  62
  63   // TODO: can this handle mono displays? If not, we should have an extra
  64   // flag to specify whether this should be black or white by default.
  65
  66   int AllocColour(WXDisplay* display, bool realloc = FALSE);
  67
  68  private:
  69   bool          m_isInit;
  70   unsigned char m_red;
  71   unsigned char m_blue;
  72   unsigned char m_green;
  73  public:
  74   int           m_pixel;
  75
  76 };
  77
  78 #define wxColor wxColour
  79
  80 #endif
  81         // _WX_COLOUR_H_