/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/msw/colour.h
// Purpose: wxColour class
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows licence
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifndef __COLOURH__
-#define __COLOURH__
+#ifndef _WX_COLOUR_H_
+#define _WX_COLOUR_H_
-#ifdef __GNUG__
-#pragma interface "colour.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+ #pragma interface "colour.h"
#endif
+#include "wx/object.h"
+
+// ----------------------------------------------------------------------------
// Colour
-class WXDLLEXPORT wxColour: public wxObject
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxColour : public wxObject
{
- DECLARE_DYNAMIC_CLASS(wxColour)
public:
- wxColour(void);
- wxColour(const unsigned char r, const unsigned char g, const unsigned char b);
- wxColour(const wxColour& col);
- wxColour(const wxString& col);
- ~wxColour(void) ;
- wxColour& operator =(const wxColour& src) ;
- wxColour& operator =(const wxString& src) ;
- inline int Ok(void) const { return (m_isInit) ; }
-
- void Set(unsigned char r, unsigned char g, unsigned char b);
-
- // Let's remove this inelegant function
-#if WXWIN_COMPATIBILITY
- void Get(unsigned char *r, unsigned char *g, unsigned char *b) const;
-#endif
+ // constructors
+ // ------------
- inline unsigned char Red(void) const { return m_red; }
- inline unsigned char Green(void) const { return m_green; }
- inline unsigned char Blue(void) const { return m_blue; }
+ // default
+ wxColour() { Init(); }
- inline bool operator == (const wxColour& colour) { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); }
+ // from separate RGB
+ wxColour( unsigned char red, unsigned char green, unsigned char blue )
+ { Set(red, green, blue); }
- inline bool operator != (const wxColour& colour) { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); }
+ // from packed RGB
+ wxColour( unsigned long colRGB ) { Set(colRGB); }
- WXCOLORREF GetPixel(void) const { return m_pixel; };
+ // implicit conversion from the colour name
+ wxColour(const wxString &colourName) { InitFromName(colourName); }
+ wxColour(const wxChar *colourName) { InitFromName(colourName); }
- private:
- bool m_isInit;
- unsigned char m_red;
- unsigned char m_blue;
- unsigned char m_green;
- public:
- WXCOLORREF m_pixel ;
-};
-#define wxColor wxColour
+ // copy ctors and assignment operators
+ wxColour(const wxColour& col);
+ wxColour& operator=( const wxColour& col);
+
+ // dtor
+ ~wxColour();
+
+
+ // other methods
+ // -------------
+
+ // to have the matching Create also for this class
+ void Create( unsigned char red, unsigned char green, unsigned char blue )
+ { Set(red, green, blue); }
+
+ // Set() functions
+ void Set(unsigned char red, unsigned char green, unsigned char blue);
+ void Set(unsigned long colRGB)
+ {
+ // we don't need to know sizeof(long) here because we assume that the three
+ // least significant bytes contain the R, G and B values
+ Set((unsigned char)colRGB,
+ (unsigned char)(colRGB >> 8),
+ (unsigned char)(colRGB >> 16));
+ }
+
+ // accessors
+ // ---------
+
+ bool Ok() const { return m_isInit; }
+
+ unsigned char Red() const { return m_red; }
+ unsigned char Green() const { return m_green; }
+ unsigned char Blue() const { return m_blue; }
+
+ // comparison
+ bool operator==(const wxColour& colour) const
+ {
+ return m_isInit == colour.m_isInit
+ && m_red == colour.m_red
+ && m_green == colour.m_green
+ && m_blue == colour.m_blue;
+ }
+
+ bool operator != (const wxColour& colour) const { return !(*this == colour); }
+
+ WXCOLORREF GetPixel() const { return m_pixel; };
+
+ void InitFromName(const wxString& colourName);
+
+public:
+ WXCOLORREF m_pixel;
+
+protected:
+ // Helper function
+ void Init();
+
+private:
+ bool m_isInit;
+ unsigned char m_red;
+ unsigned char m_blue;
+ unsigned char m_green;
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxColour)
+};
#endif
- // __COLOURH__
+ // _WX_COLOUR_H_