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 public:
  26   // ctors
  27     // default
  28   wxColour();
  29     // from RGB
  30   wxColour( unsigned char red, unsigned char green, unsigned char blue );
  31     // implicit conversion from the colour name
  32   wxColour( const wxString &colourName ) { InitFromName(colourName); }
  33   wxColour( const char *colourName ) { InitFromName(colourName); }
  34
  35     // copy ctors and assignment operators
  36   wxColour( const wxColour& col );
  37   wxColour( const wxColour* col );
  38   wxColour& operator = ( const wxColour& col );
  39
  40     // dtor
  41   ~wxColour();
  42
  43   // Set() functions
  44   void Set( unsigned char red, unsigned char green, unsigned char blue );
  45   void Set( unsigned long colRGB )
  46   {
  47     // we don't need to know sizeof(long) here because we assume that the three
  48     // least significant bytes contain the R, G and B values
  49     Set((unsigned char)colRGB,
  50         (unsigned char)(colRGB >> 8),
  51         (unsigned char)(colRGB >> 16));
  52   }
  53
  54   // accessors
  55   bool Ok() const {return m_isInit; }
  56
  57   int GetPixel() const { return m_pixel; };
  58   void SetPixel(int pixel) { m_pixel = pixel; m_isInit = TRUE; };
  59
  60   // Allocate a colour, or nearest colour, using the given display.
  61   // If realloc is TRUE, ignore the existing pixel, otherwise just return
  62   // the existing one.
  63   // Returns the allocated pixel.
  64
  65   // TODO: can this handle mono displays? If not, we should have an extra
  66   // flag to specify whether this should be black or white by default.
  67
  68   int AllocColour(WXDisplay* display, bool realloc = FALSE);
  69
  70 private:
  71   bool          m_isInit;
  72   unsigned char m_red;
  73   unsigned char m_blue;
  74   unsigned char m_green;
  75
  76 public:
  77   int           m_pixel;
  78 };
  79
  80 #endif
  81         // _WX_COLOUR_H_