include/wx/gtk/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        colour.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10
  11 #ifndef __GTKCOLOURH__
  12 #define __GTKCOLOURH__
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include "wx/defs.h"
  19 #include "wx/object.h"
  20 #include "wx/string.h"
  21 #include "wx/gdiobj.h"
  22 #include "wx/palette.h"
  23
  24 //-----------------------------------------------------------------------------
  25 // classes
  26 //-----------------------------------------------------------------------------
  27
  28 class wxDC;
  29 class wxPaintDC;
  30 class wxBitmap;
  31 class wxWindow;
  32
  33 class wxColour;
  34
  35 //-----------------------------------------------------------------------------
  36 // wxColour
  37 //-----------------------------------------------------------------------------
  38
  39 class wxColour: public wxGDIObject
  40 {
  41 public:
  42     wxColour() { }
  43
  44     // Construct from RGB
  45     wxColour( unsigned char red, unsigned char green, unsigned char blue );
  46     wxColour( unsigned long colRGB ) { Set(colRGB); }
  47
  48     // Implicit conversion from the colour name
  49     wxColour( const wxString &colourName ) { InitFromName(colourName); }
  50     wxColour( const char *colourName ) { InitFromName(colourName); }
  51
  52     wxColour( const wxColour& col ) { Ref(col); }
  53     wxColour& operator = ( const wxColour& col ) { Ref(col); return *this; }
  54
  55     ~wxColour();
  56
  57     bool Ok() const { return m_refData != NULL; }
  58
  59     bool operator == ( const wxColour& col ) const;
  60     bool operator != ( const wxColour& col ) const { return !(*this == col); }
  61
  62     void Set( unsigned char red, unsigned char green, unsigned char blue );
  63     void Set( unsigned long colRGB )
  64     {
  65         // We don't need to know sizeof(long) here because we assume that the three
  66         // least significant bytes contain the R, G and B values
  67         Set((unsigned char)colRGB,
  68             (unsigned char)(colRGB >> 8),
  69             (unsigned char)(colRGB >> 16));
  70     }
  71
  72     unsigned char Red() const;
  73     unsigned char Green() const;
  74     unsigned char Blue() const;
  75
  76
  77     // Implementation part
  78     void CalcPixel( GdkColormap *cmap );
  79     int GetPixel() const;
  80     GdkColor *GetColor() const;
  81
  82 protected:
  83     // ref counting code
  84     virtual wxObjectRefData *CreateRefData() const;
  85     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
  86
  87     // Helper functions
  88     void InitFromName(const wxString& colourName);
  89
  90 private:
  91     DECLARE_DYNAMIC_CLASS(wxColour)
  92 };
  93
  94 #endif // __GTKCOLOURH__