| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: colour.h |
| 3 | // Purpose: wxColour class |
| 4 | // Author: Julian Smart |
| 5 | // Modified by: |
| 6 | // Created: 17/09/98 |
| 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 | |
| 19 | #include "wx/object.h" |
| 20 | #include "wx/string.h" |
| 21 | |
| 22 | // Colour |
| 23 | class WXDLLEXPORT wxColour : public wxObject |
| 24 | { |
| 25 | DECLARE_DYNAMIC_CLASS(wxColour) |
| 26 | public: |
| 27 | // ctors |
| 28 | // default |
| 29 | wxColour(); |
| 30 | // from RGB |
| 31 | wxColour( unsigned char red, unsigned char green, unsigned char blue ) |
| 32 | { Set(red, green, blue); } |
| 33 | wxColour( unsigned long colRGB ) { Set(colRGB); } |
| 34 | |
| 35 | // implicit conversion from the colour name |
| 36 | wxColour( const wxString &colourName ) { InitFromName(colourName); } |
| 37 | wxColour( const char *colourName ) { InitFromName(colourName); } |
| 38 | |
| 39 | // copy ctors and assignment operators |
| 40 | wxColour( const wxColour& col ); |
| 41 | wxColour& operator = ( const wxColour& col ); |
| 42 | |
| 43 | // dtor |
| 44 | ~wxColour(); |
| 45 | |
| 46 | // Set() functions |
| 47 | void Set( unsigned char red, unsigned char green, unsigned char blue ); |
| 48 | void Set( unsigned long colRGB ) |
| 49 | { |
| 50 | // we don't need to know sizeof(long) here because we assume that the three |
| 51 | // least significant bytes contain the R, G and B values |
| 52 | Set((unsigned char)colRGB, |
| 53 | (unsigned char)(colRGB >> 8), |
| 54 | (unsigned char)(colRGB >> 16)); |
| 55 | } |
| 56 | |
| 57 | // accessors |
| 58 | bool Ok() const {return m_isInit; } |
| 59 | unsigned char Red() const { return m_red; } |
| 60 | unsigned char Green() const { return m_green; } |
| 61 | unsigned char Blue() const { return m_blue; } |
| 62 | |
| 63 | int GetPixel() const { return m_pixel; }; |
| 64 | void SetPixel(int pixel) { m_pixel = pixel; m_isInit = true; }; |
| 65 | |
| 66 | inline bool operator == (const wxColour& colour) const { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); } |
| 67 | |
| 68 | inline bool operator != (const wxColour& colour) const { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); } |
| 69 | |
| 70 | // Get colour from name or wxNullColour |
| 71 | static wxColour CreateByName(const wxString& name); |
| 72 | |
| 73 | // Allocate a colour, or nearest colour, using the given display. |
| 74 | // If realloc is true, ignore the existing pixel, otherwise just return |
| 75 | // the existing one. |
| 76 | // Returns the allocated pixel. |
| 77 | |
| 78 | // TODO: can this handle mono displays? If not, we should have an extra |
| 79 | // flag to specify whether this should be black or white by default. |
| 80 | |
| 81 | int AllocColour(WXDisplay* display, bool realloc = false); |
| 82 | |
| 83 | void InitFromName(const wxString& col); |
| 84 | |
| 85 | protected: |
| 86 | // Helper function |
| 87 | void Init(); |
| 88 | |
| 89 | private: |
| 90 | bool m_isInit; |
| 91 | unsigned char m_red; |
| 92 | unsigned char m_blue; |
| 93 | unsigned char m_green; |
| 94 | |
| 95 | public: |
| 96 | int m_pixel; |
| 97 | }; |
| 98 | |
| 99 | #endif |
| 100 | // _WX_COLOUR_H_ |