| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: colour.h |
| 3 | // Purpose: wxColour class |
| 4 | // Author: AUTHOR |
| 5 | // Modified by: |
| 6 | // Created: ??/??/98 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) AUTHOR |
| 9 | // Licence: wxWindows licence |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef _WX_COLOUR_H_ |
| 13 | #define _WX_COLOUR_H_ |
| 14 | |
| 15 | #ifdef __GNUG__ |
| 16 | #pragma interface "colour.h" |
| 17 | #endif |
| 18 | |
| 19 | #include "wx/object.h" |
| 20 | #include "wx/string.h" |
| 21 | |
| 22 | // Colour |
| 23 | class WXDLLEXPORT wxColour: public wxObject |
| 24 | { |
| 25 | public: |
| 26 | // ctors |
| 27 | // default |
| 28 | wxColour(); |
| 29 | // from RGB |
| 30 | wxColour( unsigned char red, unsigned char green, unsigned char blue ); |
| 31 | // implicit conversion from the colour name |
| 32 | wxColour( const wxString &colourName ) { InitFromName(colourName); } |
| 33 | wxColour( const char *colourName ) { InitFromName(colourName); } |
| 34 | |
| 35 | // copy ctors and assignment operators |
| 36 | wxColour( const wxColour& col ); |
| 37 | wxColour( const wxColour* col ); |
| 38 | wxColour& operator = ( const wxColour& col ); |
| 39 | |
| 40 | // dtor |
| 41 | ~wxColour(); |
| 42 | |
| 43 | // Set() functions |
| 44 | void Set( unsigned char red, unsigned char green, unsigned char blue ); |
| 45 | void Set( unsigned long colRGB ) |
| 46 | { |
| 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 |
| 49 | Set((unsigned char)colRGB, |
| 50 | (unsigned char)(colRGB >> 8), |
| 51 | (unsigned char)(colRGB >> 16)); |
| 52 | } |
| 53 | |
| 54 | // accessors |
| 55 | bool Ok() const {return m_isInit; } |
| 56 | |
| 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 | |
| 62 | unsigned char Red() const { return m_red; } |
| 63 | unsigned char Green() const { return m_green; } |
| 64 | unsigned char Blue() const { return m_blue; } |
| 65 | |
| 66 | // comparison |
| 67 | bool operator == (const wxColour& colour) const |
| 68 | { |
| 69 | return (m_red == colour.m_red && |
| 70 | m_green == colour.m_green && |
| 71 | m_blue == colour.m_blue); |
| 72 | } |
| 73 | bool operator != (const wxColour& colour) const { return !(*this == colour); } |
| 74 | |
| 75 | void InitFromName(const wxString& col); |
| 76 | |
| 77 | /* TODO |
| 78 | WXCOLORREF GetPixel() const { return m_pixel; }; |
| 79 | */ |
| 80 | |
| 81 | private: |
| 82 | bool m_isInit; |
| 83 | unsigned char m_red; |
| 84 | unsigned char m_blue; |
| 85 | unsigned char m_green; |
| 86 | |
| 87 | public: |
| 88 | /* TODO: implementation |
| 89 | WXCOLORREF m_pixel ; |
| 90 | */ |
| 91 | |
| 92 | private: |
| 93 | DECLARE_DYNAMIC_CLASS(wxColour) |
| 94 | }; |
| 95 | |
| 96 | #endif |
| 97 | // _WX_COLOUR_H_ |