]>
Commit | Line | Data |
---|---|---|
0e320a79 DW |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: colour.h | |
3 | // Purpose: wxColour class | |
37f214d5 | 4 | // Author: David Webster |
0e320a79 | 5 | // Modified by: |
37f214d5 | 6 | // Created: 10/13/99 |
0e320a79 | 7 | // RCS-ID: $Id$ |
37f214d5 | 8 | // Copyright: (c) David Webster |
0e320a79 DW |
9 | // Licence: wxWindows licence |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_COLOUR_H_ | |
13 | #define _WX_COLOUR_H_ | |
14 | ||
0e320a79 | 15 | #include "wx/object.h" |
0e320a79 DW |
16 | |
17 | // Colour | |
18 | class WXDLLEXPORT wxColour: public wxObject | |
19 | { | |
20 | public: | |
a0606634 DW |
21 | // |
22 | // Ctors | |
23 | // | |
24 | ||
25 | // | |
26 | // Default | |
27 | // | |
28 | wxColour(); | |
29 | ||
30 | // | |
0e320a79 | 31 | // from RGB |
a0606634 DW |
32 | // |
33 | wxColour( unsigned char cRed | |
34 | ,unsigned char cGreen | |
35 | ,unsigned char cBlue | |
36 | ); | |
37 | ||
38 | // | |
39 | // Implicit conversion from the colour name | |
40 | // | |
41 | wxColour(const wxString& rColourName) { InitFromName(rColourName); } | |
42 | wxColour(const char* zColourName) { InitFromName(zColourName); } | |
43 | ||
44 | // | |
45 | // Copy ctors and assignment operators | |
46 | // | |
47 | wxColour(const wxColour& rCol); | |
48 | wxColour(const wxColour* pCol); | |
49 | wxColour&operator = (const wxColour& rCol); | |
50 | ||
51 | // | |
52 | // Dtor | |
53 | // | |
54 | ~wxColour(); | |
55 | ||
56 | // | |
57 | // Set functions | |
58 | // | |
59 | void Set( unsigned char cRed | |
60 | ,unsigned char cGreen | |
61 | ,unsigned char cBlue | |
62 | ); | |
63 | void Set(unsigned long lColRGB) | |
64 | { | |
65 | // | |
66 | // We don't need to know sizeof(long) here because we assume that the three | |
67 | // least significant bytes contain the R, G and B values | |
68 | // | |
69 | Set( (unsigned char)lColRGB | |
70 | ,(unsigned char)(lColRGB >> 8) | |
71 | ,(unsigned char)(lColRGB >> 16) | |
72 | ); | |
73 | } | |
74 | ||
75 | // | |
76 | // Accessors | |
77 | bool Ok(void) const {return m_bIsInit; } | |
78 | ||
79 | // | |
80 | // Let's remove this inelegant function | |
81 | // | |
0e320a79 | 82 | #if WXWIN_COMPATIBILITY |
a0606634 DW |
83 | void Get( unsigned char* pRed |
84 | ,unsigned char* pGreen | |
85 | ,unsigned char* pBlue | |
86 | ) const; | |
0e320a79 DW |
87 | #endif |
88 | ||
a0606634 DW |
89 | unsigned char Red(void) const { return m_cRed; } |
90 | unsigned char Green(void) const { return m_cGreen; } | |
91 | unsigned char Blue(void) const { return m_cBlue; } | |
0e320a79 | 92 | |
a0606634 DW |
93 | // |
94 | // Comparison | |
95 | // | |
96 | bool operator == (const wxColour& rColour) const | |
97 | { | |
98 | return (m_cRed == rColour.m_cRed && | |
99 | m_cGreen == rColour.m_cGreen && | |
100 | m_cBlue == rColour.m_cBlue | |
101 | ); | |
102 | } | |
103 | bool operator != (const wxColour& rColour) const { return !(*this == rColour); } | |
0e320a79 | 104 | |
a0606634 DW |
105 | void InitFromName(const wxString& rCol); |
106 | WXCOLORREF GetPixel(void) const { return m_vPixel; }; | |
0e320a79 DW |
107 | |
108 | private: | |
a0606634 DW |
109 | bool m_bIsInit; |
110 | unsigned char m_cRed; | |
111 | unsigned char m_cBlue; | |
112 | unsigned char m_cGreen; | |
0e320a79 DW |
113 | |
114 | public: | |
a0606634 | 115 | WXCOLORREF m_vPixel ; |
0e320a79 DW |
116 | private: |
117 | DECLARE_DYNAMIC_CLASS(wxColour) | |
a0606634 | 118 | }; // end of class wxColour |
0e320a79 DW |
119 | |
120 | #endif | |
121 | // _WX_COLOUR_H_ |