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   // ctors
  43     // default
  44   wxColour();
  45     // from RGB
  46   wxColour( unsigned char red, unsigned char green, unsigned char blue );
  47     // implicit conversion from the colour name
  48   wxColour( const wxString &colourName ) { InitFromName(colourName); }
  49   wxColour( const char *colourName ) { InitFromName(colourName); }
  50
  51     // copy ctors and assignment operators
  52   wxColour( const wxColour& col );
  53   wxColour& operator = ( const wxColour& col );
  54
  55     // dtor
  56   ~wxColour();
  57
  58   // comparison
  59   bool operator == ( const wxColour& col );
  60   bool operator != ( const wxColour& col );
  61
  62   // accessors
  63   void Set( unsigned char red, unsigned char green, unsigned char blue );
  64   unsigned char Red() const;
  65   unsigned char Green() const;
  66   unsigned char Blue() const;
  67   bool Ok() const;
  68
  69   // implementation
  70   void CalcPixel( GdkColormap *cmap );
  71   int GetPixel() const;
  72   GdkColor *GetColor() const;
  73
  74 protected:
  75   // helper functions
  76   void InitFromName(const wxString& colourName);
  77
  78 private:
  79   DECLARE_DYNAMIC_CLASS(wxColour)
  80 };
  81
  82 #endif // __GTKCOLOURH__