include/wx/motif/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/motif/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 #include "wx/object.h"
  16 #include "wx/string.h"
  17
  18 // Colour
  19 class WXDLLEXPORT wxColour : public wxObject
  20 {
  21     DECLARE_DYNAMIC_CLASS(wxColour)
  22 public:
  23     // constructors
  24     // ------------
  25
  26     // default
  27     wxColour();
  28
  29     // from separate RGB
  30     wxColour( unsigned char red, unsigned char green, unsigned char blue )
  31         { Set(red, green, blue); }
  32
  33     // from packed RGB
  34     wxColour( unsigned long colRGB ) { Set(colRGB); }
  35
  36     // implicit conversion from the colour name
  37     wxColour( const wxString &colourName ) { InitFromName(colourName); }
  38     wxColour( const char *colourName ) { InitFromName(colourName); }
  39
  40     // copy ctors and assignment operators
  41     wxColour( const wxColour& col );
  42     wxColour& operator = ( const wxColour& col );
  43
  44     // dtor
  45     ~wxColour();
  46
  47     // Set() functions
  48     void Set( unsigned char red, unsigned char green, unsigned char blue );
  49     void Set( unsigned long colRGB )
  50     {
  51         // we don't need to know sizeof(long) here because we assume that the three
  52         // least significant bytes contain the R, G and B values
  53         Set((unsigned char)colRGB,
  54             (unsigned char)(colRGB >> 8),
  55             (unsigned char)(colRGB >> 16));
  56     }
  57
  58     // accessors
  59     bool Ok() const {return m_isInit; }
  60     unsigned char Red() const { return m_red; }
  61     unsigned char Green() const { return m_green; }
  62     unsigned char Blue() const { return m_blue; }
  63
  64     int GetPixel() const { return m_pixel; };
  65     void SetPixel(int pixel) { m_pixel = pixel; m_isInit = true; };
  66
  67     inline bool operator == (const wxColour& colour) const { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); }
  68
  69     inline bool operator != (const wxColour& colour) const { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); }
  70
  71     // Get colour from name or wxNullColour
  72     static wxColour CreateByName(const wxString& name);
  73
  74     // Allocate a colour, or nearest colour, using the given display.
  75     // If realloc is true, ignore the existing pixel, otherwise just return
  76     // the existing one.
  77     // Returns the allocated pixel.
  78
  79     // TODO: can this handle mono displays? If not, we should have an extra
  80     // flag to specify whether this should be black or white by default.
  81
  82     int AllocColour(WXDisplay* display, bool realloc = false);
  83
  84     void InitFromName(const wxString& col);
  85
  86 protected:
  87     // Helper function
  88     void Init();
  89
  90 private:
  91     bool          m_isInit;
  92     unsigned char m_red;
  93     unsigned char m_blue;
  94     unsigned char m_green;
  95
  96 public:
  97     int           m_pixel;
  98 };
  99
 100 #endif
 101 // _WX_COLOUR_H_