]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/colour.h
Moved wxToolBarSimple to deprecated library
[wxWidgets.git] / include / wx / msw / colour.h
CommitLineData
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 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
2bda0e17
KB
16#pragma interface "colour.h"
17#endif
2d996ed1 18#include "wx/object.h"
2bda0e17
KB
19
20// Colour
21class WXDLLEXPORT wxColour: public wxObject
22{
2bda0e17 23public:
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); }
deb3ea6a 33 wxColour( const wxChar *colourName ) { InitFromName(colourName); }
e4a81a2e 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
57de2373
SC
43 // to have the matching Create also for this class
44 void Create( unsigned char red, unsigned char green, unsigned char blue )
45 { Set( red , green , blue ) ; }
46
e4a81a2e
VZ
47 // Set() functions
48 void Set( unsigned char red, unsigned char green, unsigned char blue );
e0a09ce4
RD
49 void Set(unsigned long colRGB)
50 {
ec845369
VZ
51 // we don't need to know sizeof(long) here because we assume that the three
52 // least significant bytes contain the R, G and B values
e0a09ce4 53 Set((unsigned char)colRGB,
ec845369 54 (unsigned char)(colRGB >> 8),
e0a09ce4 55 (unsigned char)(colRGB >> 16));
ec845369 56 }
2bda0e17 57
e4a81a2e
VZ
58 // accessors
59 bool Ok() const {return m_isInit; }
60
2bda0e17
KB
61 // Let's remove this inelegant function
62#if WXWIN_COMPATIBILITY
63 void Get(unsigned char *r, unsigned char *g, unsigned char *b) const;
64#endif
65
e4a81a2e
VZ
66 unsigned char Red() const { return m_red; }
67 unsigned char Green() const { return m_green; }
68 unsigned char Blue() const { return m_blue; }
2bda0e17 69
e4a81a2e 70 // comparison
615dca33 71 bool operator==(const wxColour& colour) const
e4a81a2e 72 {
615dca33
VZ
73 return m_isInit == colour.m_isInit &&
74 m_red == colour.m_red &&
75 m_green == colour.m_green &&
76 m_blue == colour.m_blue;
e4a81a2e 77 }
615dca33 78
33b64e6f 79 bool operator != (const wxColour& colour) const { return !(*this == colour); }
2bda0e17 80
68dda785 81 WXCOLORREF GetPixel() const { return m_pixel; };
2bda0e17 82
8f177c8e
VZ
83public:
84 WXCOLORREF m_pixel;
85
68dda785 86private:
8f177c8e 87 bool m_isInit;
2bda0e17
KB
88 unsigned char m_red;
89 unsigned char m_blue;
90 unsigned char m_green;
68dda785
VZ
91
92 // helper func
93 void InitFromName(const wxString& colourName);
94
68dda785
VZ
95private:
96 DECLARE_DYNAMIC_CLASS(wxColour)
2bda0e17
KB
97};
98
2bda0e17 99#endif
8f177c8e 100 // _WX_COLOUR_H_