]> git.saurik.com Git - wxWidgets.git/blob - include/wx/mgl/colour.h
Removed this file since it was only stubs and we now have the common
[wxWidgets.git] / include / wx / mgl / colour.h
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$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_COLOUR_H_
13 #define _WX_COLOUR_H_
14
15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16 #pragma interface "colour.h"
17 #endif
18 #include "wx/object.h"
19
20 // Colour
21 class WXDLLEXPORT wxColour: public wxObject
22 {
23 public:
24 // ctors
25 // default
26 wxColour();
27 // from RGB
28 wxColour(unsigned char red, unsigned char green, unsigned char blue)
29 { Set(red, green, blue); }
30 wxColour(unsigned long colRGB) { Set(colRGB); }
31
32 // implicit conversion from the colour name
33 wxColour(const wxString &colourName) { InitFromName(colourName); }
34 wxColour(const char *colourName) { InitFromName(colourName); }
35
36
37 // copy ctors and assignment operators
38 wxColour(const wxColour& col);
39 wxColour& operator = (const wxColour& col);
40
41 // dtor
42 ~wxColour();
43
44 // Set() functions
45 void Set(unsigned char red, unsigned char green, unsigned char blue);
46 void Set(unsigned long colRGB)
47 {
48 // we don't need to know sizeof(long) here because we assume that the three
49 // least significant bytes contain the R, G and B values
50 Set((unsigned char)colRGB,
51 (unsigned char)(colRGB >> 8),
52 (unsigned char)(colRGB >> 16));
53 }
54
55 // accessors
56 bool Ok() const { return m_isInit; }
57
58 unsigned char Red() const { return m_red; }
59 unsigned char Green() const { return m_green; }
60 unsigned char Blue() const { return m_blue; }
61
62 // comparison
63 bool operator == (const wxColour& colour) const
64 {
65 return (m_red == colour.m_red &&
66 m_green == colour.m_green &&
67 m_blue == colour.m_blue &&
68 m_isInit == colour.m_isInit);
69 }
70 bool operator != (const wxColour& colour) const { return !(*this == colour); }
71
72 void InitFromName(const wxString& colourName);
73
74 protected:
75
76 // Helper function
77 void Init();
78
79 private:
80 bool m_isInit;
81 unsigned char m_red;
82 unsigned char m_blue;
83 unsigned char m_green;
84
85 private:
86 DECLARE_DYNAMIC_CLASS(wxColour)
87 };
88
89 #endif
90 // _WX_COLOUR_H_