Commit | Line | Data |
---|---|---|
2bda0e17 KB |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: colour.h | |
3 | // Purpose: wxColour class | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
bbcdf8bc | 8 | // Copyright: (c) Julian Smart |
8f177c8e | 9 | // Licence: wxWindows licence |
2bda0e17 KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
bbcdf8bc JS |
12 | #ifndef _WX_COLOUR_H_ |
13 | #define _WX_COLOUR_H_ | |
2bda0e17 KB |
14 | |
15 | #ifdef __GNUG__ | |
16 | #pragma interface "colour.h" | |
17 | #endif | |
2d996ed1 | 18 | #include "wx/object.h" |
2bda0e17 KB |
19 | |
20 | // Colour | |
21 | class WXDLLEXPORT wxColour: public wxObject | |
22 | { | |
2bda0e17 | 23 | public: |
e4a81a2e VZ |
24 | // ctors |
25 | // default | |
68dda785 | 26 | wxColour(); |
e4a81a2e | 27 | // from RGB |
87832b70 | 28 | wxColour( unsigned char red, unsigned char green, unsigned char blue ); |
5f83a454 RD |
29 | wxColour( unsigned long colRGB ) { Set(colRGB); } |
30 | ||
e4a81a2e VZ |
31 | // implicit conversion from the colour name |
32 | wxColour( const wxString &colourName ) { InitFromName(colourName); } | |
33 | wxColour( const char *colourName ) { InitFromName(colourName); } | |
34 | ||
5f83a454 | 35 | |
e4a81a2e VZ |
36 | // copy ctors and assignment operators |
37 | wxColour( const wxColour& col ); | |
e4a81a2e VZ |
38 | wxColour& operator = ( const wxColour& col ); |
39 | ||
40 | // dtor | |
68dda785 VZ |
41 | ~wxColour(); |
42 | ||
e4a81a2e VZ |
43 | // Set() functions |
44 | void Set( unsigned char red, unsigned char green, unsigned char blue ); | |
e0a09ce4 RD |
45 | void Set(unsigned long colRGB) |
46 | { | |
ec845369 VZ |
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 | |
e0a09ce4 | 49 | Set((unsigned char)colRGB, |
ec845369 | 50 | (unsigned char)(colRGB >> 8), |
e0a09ce4 | 51 | (unsigned char)(colRGB >> 16)); |
ec845369 | 52 | } |
2bda0e17 | 53 | |
e4a81a2e VZ |
54 | // accessors |
55 | bool Ok() const {return m_isInit; } | |
56 | ||
2bda0e17 KB |
57 | // Let's remove this inelegant function |
58 | #if WXWIN_COMPATIBILITY | |
59 | void Get(unsigned char *r, unsigned char *g, unsigned char *b) const; | |
60 | #endif | |
61 | ||
e4a81a2e VZ |
62 | unsigned char Red() const { return m_red; } |
63 | unsigned char Green() const { return m_green; } | |
64 | unsigned char Blue() const { return m_blue; } | |
2bda0e17 | 65 | |
e4a81a2e | 66 | // comparison |
615dca33 | 67 | bool operator==(const wxColour& colour) const |
e4a81a2e | 68 | { |
615dca33 VZ |
69 | return m_isInit == colour.m_isInit && |
70 | m_red == colour.m_red && | |
71 | m_green == colour.m_green && | |
72 | m_blue == colour.m_blue; | |
e4a81a2e | 73 | } |
615dca33 | 74 | |
33b64e6f | 75 | bool operator != (const wxColour& colour) const { return !(*this == colour); } |
2bda0e17 | 76 | |
68dda785 | 77 | WXCOLORREF GetPixel() const { return m_pixel; }; |
2bda0e17 | 78 | |
8f177c8e VZ |
79 | public: |
80 | WXCOLORREF m_pixel; | |
81 | ||
68dda785 | 82 | private: |
8f177c8e | 83 | bool m_isInit; |
2bda0e17 KB |
84 | unsigned char m_red; |
85 | unsigned char m_blue; | |
86 | unsigned char m_green; | |
68dda785 VZ |
87 | |
88 | // helper func | |
89 | void InitFromName(const wxString& colourName); | |
90 | ||
68dda785 VZ |
91 | private: |
92 | DECLARE_DYNAMIC_CLASS(wxColour) | |
2bda0e17 KB |
93 | }; |
94 | ||
2bda0e17 | 95 | #endif |
8f177c8e | 96 | // _WX_COLOUR_H_ |