]> git.saurik.com Git - wxWidgets.git/blame - include/wx/os2/colour.h
1. removed 'B' flag from treebase.cpp and regenerated the makefiles
[wxWidgets.git] / include / wx / os2 / colour.h
CommitLineData
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
18class WXDLLEXPORT wxColour: public wxObject
19{
20public:
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
8c5907ce 77 //
a0606634
DW
78 bool Ok(void) const {return m_bIsInit; }
79
80 //
81 // Let's remove this inelegant function
82 //
0e320a79 83#if WXWIN_COMPATIBILITY
a0606634
DW
84 void Get( unsigned char* pRed
85 ,unsigned char* pGreen
86 ,unsigned char* pBlue
87 ) const;
0e320a79
DW
88#endif
89
a0606634
DW
90 unsigned char Red(void) const { return m_cRed; }
91 unsigned char Green(void) const { return m_cGreen; }
92 unsigned char Blue(void) const { return m_cBlue; }
0e320a79 93
a0606634
DW
94 //
95 // Comparison
96 //
97 bool operator == (const wxColour& rColour) const
98 {
99 return (m_cRed == rColour.m_cRed &&
100 m_cGreen == rColour.m_cGreen &&
101 m_cBlue == rColour.m_cBlue
102 );
103 }
104 bool operator != (const wxColour& rColour) const { return !(*this == rColour); }
0e320a79 105
a0606634
DW
106 void InitFromName(const wxString& rCol);
107 WXCOLORREF GetPixel(void) const { return m_vPixel; };
0e320a79
DW
108
109private:
a0606634
DW
110 bool m_bIsInit;
111 unsigned char m_cRed;
112 unsigned char m_cBlue;
113 unsigned char m_cGreen;
0e320a79
DW
114
115public:
a0606634 116 WXCOLORREF m_vPixel ;
0e320a79
DW
117private:
118 DECLARE_DYNAMIC_CLASS(wxColour)
a0606634 119}; // end of class wxColour
0e320a79
DW
120
121#endif
122 // _WX_COLOUR_H_