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