include/wx/x11/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 wxGDIObject
  37 {
  38 public:
  39     wxColour() { }
  40
  41     // Construct from RGB
  42     wxColour( unsigned char red, unsigned char green, unsigned char blue );
  43     wxColour( unsigned long colRGB ) { Set(colRGB); }
  44
  45     // Implicit conversion from the colour name
  46     wxColour( const wxString &colourName ) { InitFromName(colourName); }
  47     wxColour( const char *colourName ) { InitFromName( wxString::FromAscii(colourName) ); }
  48 #if wxUSE_UNICODE
  49     wxColour( const wxChar *colourName ) { InitFromName( wxString(colourName) ); }
  50 #endif
  51
  52     // Get colour from name or wxNullColour
  53     static wxColour CreateByName(const wxString& name);
  54
  55     wxColour( const wxColour& col ) { Ref(col); }
  56     wxColour& operator = ( const wxColour& col ) { Ref(col); return *this; }
  57
  58     ~wxColour();
  59
  60     bool Ok() const { return m_refData != NULL; }
  61
  62     bool operator == ( const wxColour& col ) const;
  63     bool operator != ( const wxColour& col ) const { return !(*this == col); }
  64
  65     void Set( unsigned char red, unsigned char green, unsigned char blue );
  66     void Set( unsigned long colRGB )
  67     {
  68         // We don't need to know sizeof(long) here because we assume that the three
  69         // least significant bytes contain the R, G and B values
  70         Set((unsigned char)colRGB,
  71             (unsigned char)(colRGB >> 8),
  72             (unsigned char)(colRGB >> 16));
  73     }
  74
  75     unsigned char Red() const;
  76     unsigned char Green() const;
  77     unsigned char Blue() const;
  78
  79     // Implementation part
  80
  81     void CalcPixel( WXColormap cmap );
  82     unsigned long GetPixel() const;
  83     WXColor *GetColor() const;
  84
  85     void InitFromName(const wxString& colourName);
  86
  87 protected:
  88     // ref counting code
  89     virtual wxObjectRefData *CreateRefData() const;
  90     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
  91
  92
  93 private:
  94     DECLARE_DYNAMIC_CLASS(wxColour)
  95 };
  96
  97 #endif
  98
  99 // _WX_COLOUR_H_
 100