include/wx/x11/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/x11/colour.h
   3 // Purpose:     wxColour class
   4 // Author:      Julian Smart, Robert Roebling
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart, Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_COLOUR_H_
  13 #define _WX_COLOUR_H_
  14
  15 #include "wx/defs.h"
  16 #include "wx/object.h"
  17 #include "wx/string.h"
  18 #include "wx/gdiobj.h"
  19 #include "wx/palette.h"
  20
  21 //-----------------------------------------------------------------------------
  22 // classes
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxDC;
  26 class WXDLLIMPEXP_CORE wxPaintDC;
  27 class WXDLLIMPEXP_CORE wxBitmap;
  28 class WXDLLIMPEXP_CORE wxWindow;
  29
  30 class WXDLLIMPEXP_CORE wxColour;
  31
  32 //-----------------------------------------------------------------------------
  33 // wxColour
  34 //-----------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxColour : public wxColourBase
  37 {
  38 public:
  39     // constructors
  40     // ------------
  41
  42     wxColour() {}
  43     DEFINE_STD_WXCOLOUR_CONSTRUCTORS
  44
  45     ~wxColour();
  46
  47     virtual bool FromString(const wxChar *str);
  48
  49     bool Ok() const { return m_refData != NULL; }
  50
  51     bool operator == ( const wxColour& col ) const;
  52     bool operator != ( const wxColour& col ) const { return !(*this == col); }
  53
  54     unsigned char Red() const;
  55     unsigned char Green() const;
  56     unsigned char Blue() const;
  57
  58     // Implementation part
  59
  60     void CalcPixel( WXColormap cmap );
  61     unsigned long GetPixel() const;
  62     WXColor *GetColor() const;
  63
  64 protected:
  65     // ref counting code
  66     virtual wxObjectRefData *CreateRefData() const;
  67     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
  68
  69     virtual void InitWith( unsigned char red, unsigned char green, unsigned char blue );
  70
  71 private:
  72     DECLARE_DYNAMIC_CLASS(wxColour)
  73 };
  74
  75 #endif
  76
  77 // _WX_COLOUR_H_